aboutsummaryrefslogtreecommitdiff
path: root/docs/project/development.md
diff options
context:
space:
mode:
authorGravatar hiroki osame <hiroki.osame@gmail.com> 2023-04-11 04:52:54 -0400
committerGravatar GitHub <noreply@github.com> 2023-04-11 01:52:54 -0700
commit14c6023e1551b76c12464a6213456f844fc2024e (patch)
treea405fba10e6781897d3971dabb5a0e35c4ac3d7e /docs/project/development.md
parentf91dc8c0d308f2b21a725aeccc58c3cfb78c1339 (diff)
downloadbun-14c6023e1551b76c12464a6213456f844fc2024e.tar.gz
bun-14c6023e1551b76c12464a6213456f844fc2024e.tar.zst
bun-14c6023e1551b76c12464a6213456f844fc2024e.zip
docs: remove dev container section (#2610)
Diffstat (limited to '')
-rw-r--r--docs/project/development.md70
1 files changed, 0 insertions, 70 deletions
diff --git a/docs/project/development.md b/docs/project/development.md
index 557809918..c077de9b7 100644
--- a/docs/project/development.md
+++ b/docs/project/development.md
@@ -183,76 +183,6 @@ You'll need a very recent version of Valgrind due to DWARF 5 debug symbols. You
valgrind --fair-sched=try --track-origins=yes bun-debug <args>
```
-## Docker Devcontainer
-
-Bun has a [Dev Container](https://containers.dev), which can be used to quickly get a development environment. We do not recommend using this, as the setup instructions above are much more complete.
-
-To develop on Linux/Windows, [Docker](https://www.docker.com) is required. If using WSL on Windows, it is recommended to use [Docker Desktop](https://docs.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers) for its WSL2 integration.
-
-### VSCode
-
-If you're using VSCode, you'll need to have the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension installed.
-
-To get started, open VS Code in the `bun` repository. The first time you try to open the dev container, the extension will automatically build it for you, based on [`Dockerfile.devcontainer`](https://github.com/oven-sh/bun/blob/main/Dockerfile.devcontainer).
-
-To open the dev container, open the command palette (`Ctrl` + `Shift` + `P`) and run: `Dev Containers: Reopen in Container`. To later rebuild it (only needed when the devcontainer itself changes, not the Bun code), run: `Dev Containers: Rebuild and Reopen in Container`.
-
-### Other editors and CLI
-
-If you're using another editor or want to manually control the dev container from the command line or a script, you'll need to install the [Dev Container CLI](https://www.npmjs.com/package/@devcontainers/cli): `npm install -g @devcontainers/cli`.
-
-To create and start the dev container, in the `bun` repository, locally run:
-
-```bash
-# `make devcontainer-<command>` should be equivalent
-# to `devcontainer <command>`, it just sets the architecture
-# so if you're on ARM64, it'll do the right thing
-$ make devcontainer-up
-```
-
-To just build the dev container image, run:
-
-```bash
-$ make devcontainer-build
-```
-
-To start a shell inside the container, run:
-
-```bash
-$ make devcontainer-sh
-
-# if it attaches to the container non-interactively,
-# instead use the regular docker exec command:
-$ docker exec -it <container-name/id> zsh
-```
-
-### Cloning
-
-You will then need to clone the GitHub repository inside that container.
-
-```bash
-# First time setup
-$ gh auth login # if it fails to open a browser, use Personal Access Token instead
-$ gh repo clone oven-sh/bun . -- --depth=1 --progress -j8
-```
-
-### Building
-
-```bash
-# Compile Bun dependencies (zig is already compiled)
-$ make devcontainer
-
-# It initializes and updates all submodules except WebKit, because WebKit
-# takes a while and it's already compiled for you. To do it manually, use:
-$ git -c submodule."src/bun.js/WebKit".update=none submodule update --init --recursive --depth=1 --progress
-
-# Build Bun for development
-$ make dev
-
-# Run Bun
-$ bun-debug
-```
-
## Troubleshooting
### libarchive