aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-10-11 14:31:39 -0700
committerGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-10-11 14:31:39 -0700
commit4c9e0099719895eaf95e3149256bf8d1338d2378 (patch)
treeeec9b60ddeef7a75d543e8dfda4a013ef1e85ee3
parent4531cf18c223bd506a2c16d11fc3fd9fa6df6178 (diff)
downloadbun-4c9e0099719895eaf95e3149256bf8d1338d2378.tar.gz
bun-4c9e0099719895eaf95e3149256bf8d1338d2378.tar.zst
bun-4c9e0099719895eaf95e3149256bf8d1338d2378.zip
Update installation.md
-rw-r--r--docs/installation.md17
1 files changed, 7 insertions, 10 deletions
diff --git a/docs/installation.md b/docs/installation.md
index 692aec5b2..6d0f3f997 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -1,6 +1,8 @@
Bun ships as a single executable that can be installed a few different ways.
-## macOS and Linux
+## Installing
+
+### macOS and Linux
{% callout %}
**Linux users** — The `unzip` package is required to install Bun. Use `sudo apt install unzip` to install `unzip` package.
@@ -35,7 +37,7 @@ $ proto install bun
{% /codetabs %}
-## Windows
+### Windows
Bun provides a _limited, experimental_ native build for Windows. At the moment, only the Bun runtime is supported.
@@ -69,7 +71,7 @@ $ docker pull oven/bun:distroless
## Checking installation
-To check that Bun was installed successfully, run `bun --version`.
+To check that Bun was installed successfully, open a new terminal window and run `bun --version`.
```sh
$ bun --version
@@ -83,10 +85,7 @@ $ bun --revision
1.x.y+b7982ac1318937560f38e0f8eb18f45eaa43480f
```
-{% details summary="Troubleshoot: command not found" %}
-**Note** — If you've installed Bun but are seeing a `command not found` error, you may have to manually add the installation directory to your `PATH`. In order for this change to persist across restarts, you'll need to update the configuration file for your system's shell.
-
-To detect your current shell:
+f you've installed Bun but are seeing a `command not found` error, you may have to manually add the installation directory to your `PATH`. First, determine what shell you're using:
```sh
$ echo $SHELL
@@ -104,7 +103,7 @@ export PATH="$BUN_INSTALL/bin:$PATH"
```
```bash#zsh
-# ~/.zshrc
+# ~/.bashrc
export BUN_INSTALL="$HOME/.bun"
export PATH="$BUN_INSTALL/bin:$PATH"
```
@@ -117,8 +116,6 @@ export PATH="$BUN_INSTALL/bin:$PATH"
{% /codetabs %}
-{% /details %}
-
## Upgrading
Once installed, the binary can upgrade itself.