aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar deijjji303 <48962555+deijjji303@users.noreply.github.com> 2022-07-12 00:36:51 +0200
committerGravatar GitHub <noreply@github.com> 2022-07-12 00:36:51 +0200
commit889ed66a013d0e211a5a0635a62f109b7bc62cd9 (patch)
tree06a6188330509f7c5edcdb889fef4120bd3a92f8
parentede75768994ba31fffaf14510a0586d5e9cbe423 (diff)
downloadbun-889ed66a013d0e211a5a0635a62f109b7bc62cd9.tar.gz
bun-889ed66a013d0e211a5a0635a62f109b7bc62cd9.tar.zst
bun-889ed66a013d0e211a5a0635a62f109b7bc62cd9.zip
docs: Added note of AVX2 requirement and mentioned Intel SDE workaround in README.md (#346)
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index 380d4900c..b834f8cbd 100644
--- a/README.md
+++ b/README.md
@@ -902,7 +902,9 @@ For developing frameworks, you can also do `bun bun --use ./relative-path-to-fra
If you’re interested in adding a framework integration, please reach out. There’s a lot here and it’s not entirely documented yet.
## Troubleshooting
+
### Illegal Instruction (Core Dumped)
+Bun currently only works on CPUs supporting the AVX2 instruction set. To run on older CPUs this can be emulated using Intel SDE, however bun won't be as fast as it would be when running on CPUs with AVX2 support.
If you get this error while bun is initializing, You probably need to wrap the bun executable with intel-sde
1. Install intel-sde
- Arch Linux: `yay -S intel-sde`
@@ -922,6 +924,7 @@ If you get this error while bun is initializing, You probably need to wrap the b
$ echo "alias bun='sde -chip-check-disable -- bun'" >> ~/.bashrc
```
You can replace `.bashrc` with `.zshrc` if you use zsh instead of bash
+
### bun not running on an M1 (or Apple Silicon)
If you see a message like this