aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jarred Sumner <jarred@jarredsumner.com> 2022-02-06 00:43:56 -0800
committerGravatar Jarred Sumner <jarred@jarredsumner.com> 2022-02-06 00:43:56 -0800
commit3a788fa0352edff521d73fa4e46a556f98ea55ff (patch)
tree522ddd8c1e8093b1bcaeaaae16b1de8a8cf41d8e
parent9715c9223abfabb3cde1a7adfaf9e2a553ee901e (diff)
downloadbun-3a788fa0352edff521d73fa4e46a556f98ea55ff.tar.gz
bun-3a788fa0352edff521d73fa4e46a556f98ea55ff.tar.zst
bun-3a788fa0352edff521d73fa4e46a556f98ea55ff.zip
Update README.md
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index ed8c7a5bf..576b85bac 100644
--- a/README.md
+++ b/README.md
@@ -93,6 +93,21 @@ bun remove react
bun add preact
```
+<detail>
+
+<summary>**For Linux users**: `bun install` needs Linux Kernel 5.6</summary> or higher to work well. The minimum is 5.1. If you're on Linux kernel 5.1 - 5.5, `bun install` should still work, but HTTP requests will be slow due to lack of support for io_uring's `connect()` operation.
+
+If you're using Ubuntu 20.04, here's how to install a [newer kernel](https://wiki.ubuntu.com/Kernel/LTSEnablementStack):
+
+```bash
+# If this returns a version >= 5.6, you don't need to do anything
+uname -r
+
+sudo apt install --install-recommends linux-generic-hwe-20.04
+```
+
+</detail>
+
## Using bun as a task runner
Instead of waiting 170ms for your npm client to start for each task, you wait 6ms for bun.