aboutsummaryrefslogtreecommitdiff
path: root/docs/installation.md
diff options
context:
space:
mode:
authorGravatar Peter Weinberg <pweinberg633@gmail.com> 2023-06-26 21:25:33 -0400
committerGravatar GitHub <noreply@github.com> 2023-06-26 18:25:33 -0700
commit7a0b1656c735ea634a7e27cb6f73254cc4411a91 (patch)
treecfea5144909087cf222ff8d14bfd265a2e26cd9f /docs/installation.md
parent28f27f733b3db072944156694301651b09b7696b (diff)
downloadbun-7a0b1656c735ea634a7e27cb6f73254cc4411a91.tar.gz
bun-7a0b1656c735ea634a7e27cb6f73254cc4411a91.tar.zst
bun-7a0b1656c735ea634a7e27cb6f73254cc4411a91.zip
docs: add troubleshooting section to installation page (#3389)
* docs: add troubleshooting section to installation page * Add note for unzip * Update msg in install.sh --------- Co-authored-by: Colin McDonnell <colinmcd94@gmail.com>
Diffstat (limited to 'docs/installation.md')
-rw-r--r--docs/installation.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/installation.md b/docs/installation.md
index 06ca2b34d..9fce0b511 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -3,17 +3,17 @@ Bun ships as a single executable that can be installed a few different ways.
{% callout %}
**Windows users** — Bun does not currently provide a native Windows build. We're working on this; progress can be tracked at [this issue](https://github.com/oven-sh/bun/issues/43). In the meantime, use one of the installation methods below for Windows Subsystem for Linux.
-**Linux users** — Kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1.
+**Linux users** — The `unzip` package is required to install Bun. Kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1.
{% /callout %}
{% codetabs %}
-```bash#Native
-$ curl -fsSL https://bun.sh/install | bash # for macOS, Linux, and WSL
+```bash#NPM
+$ npm install -g bun # the last `npm` command you'll ever need
```
-```bash#npm
-$ npm install -g bun # the last `npm` command you'll ever need
+```bash#Native
+$ curl -fsSL https://bun.sh/install | bash # for macOS, Linux, and WSL
```
```bash#Homebrew
@@ -26,7 +26,7 @@ $ docker pull oven/bun
$ docker run --rm --init --ulimit memlock=-1:-1 oven/bun
```
-```bash#proto
+```bash#Proto
$ proto install bun
```