diff options
author | 2021-12-23 19:59:26 -0800 | |
---|---|---|
committer | 2021-12-23 19:59:26 -0800 | |
commit | 77fc310a70aed3770331638301bdd62344742bac (patch) | |
tree | f4687a4f05a1ef893608d2256111b25c0e2f4c2a /README.md | |
parent | 3541177d501809289021361d2095a89b03a044f1 (diff) | |
download | bun-77fc310a70aed3770331638301bdd62344742bac.tar.gz bun-77fc310a70aed3770331638301bdd62344742bac.tar.zst bun-77fc310a70aed3770331638301bdd62344742bac.zip |
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 56 |
1 files changed, 28 insertions, 28 deletions
@@ -1070,6 +1070,34 @@ For compatibiltiy reasons, these NPM packages are embedded into Bun’s binary a Estimated: 30-90 minutes :( +### Linux + +Please use the VSCode Remote Container in this repository. + +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: + +```bash +# First time setup +gh auth login +gh repo clone Jarred-Sumner/bun . -- --depth=1 --progress -j8 + +# update all submodules except webkit because webkit takes awhile and it's already compiled for you. +git -c submodule."src/javascript/jsc/WebKit".update=none submodule update --init --recursive --depth=1 --progress + +# Compile bun dependencies (zig is already compiled) +make devcontainer + +# Build Bun for development +make dev + +# Run bun +bun-debug +``` + +This container has Zig, zls, vscode-zig, and more setup automatically for you. It is very similar to my own development environment. + ### MacOS Install LLVM 12 and homebrew dependencies: @@ -1152,34 +1180,6 @@ brew install pkg-config If you see an error about missing files on `zig build obj`, make sure you built the headers -### Linux - -Please use the VSCode Remote Container in this repository. - -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: - -```bash -# First time setup -gh auth login -gh repo clone Jarred-Sumner/bun . -- --depth=1 --progress -j8 - -# update all submodules except webkit because webkit takes awhile and it's already compiled for you. -git -c submodule."src/javascript/jsc/WebKit".update=none submodule update --init --recursive --depth=1 --progress - -# Compile bun dependencies (zig is already compiled) -make devcontainer - -# Build Bun for development -make dev - -# Run bun -bun-debug -``` - -This container has Zig, zls, vscode-zig, and more setup automatically for you. It is very similar to my own development environment. - ## vscode-zig Note: this is automatically installed on the devcontainer |