aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-12-24 06:17:14 +0000
committerGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-12-24 06:17:14 +0000
commitcfd635786a7389d14cdb29cb6e7999859a87bb1a (patch)
treee21b00f828933ce570e20d1e5372207f3a7d925d
parent11e3faa8da57748c98592f4eeb32ecdc72620857 (diff)
downloadbun-cfd635786a7389d14cdb29cb6e7999859a87bb1a.tar.gz
bun-cfd635786a7389d14cdb29cb6e7999859a87bb1a.tar.zst
bun-cfd635786a7389d14cdb29cb6e7999859a87bb1a.zip
Clarify
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index ebd47cf08..8742426c3 100644
--- a/README.md
+++ b/README.md
@@ -49,8 +49,8 @@ curl -fsSL https://bun.sh/install | bash
- [Credits](#credits)
- [License](#license)
- [Developing Bun](#developing-bun)
+ - [VSCode Dev Container](#vscode-dev-container-linux)
- [MacOS](#macos)
- - [Linux](#linux)
- [vscode-zig](#vscode-zig)
## Benchmarks
@@ -1070,12 +1070,25 @@ For compatibiltiy reasons, these NPM packages are embedded into Bun’s binary a
Estimated: 30-90 minutes :(
-### Linux
+### VSCode Dev Container (Linux)
The VSCode Remote Container in this repository is the easiest way to get started. It comes with Zig, JavaScriptCore, Zig Language Server, vscode-zig, and more pre-installed on an instance of Ubuntu.
<img src="https://user-images.githubusercontent.com/709451/147319227-6446589c-a4d9-480d-bd5b-43037a9e56fd.png" />
+To get started, install the devcontainer cli:
+
+```bash
+npm install -g @vscode/dev-container-cli
+```
+
+Then, in the `bun` repository locally run:
+
+```bash
+devcontainer build
+devcontainer open
+```
+
You will need to clone the GitHub repository inside that container, which also requires authenticating with GitHub (until Bun's repository is public). Make sure to login with a Personal Access Token rather than a web browser.
Inside the container, run this: