aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Rishi Goomar <rishig92@gmail.com> 2022-07-27 20:28:38 -0500
committerGravatar GitHub <noreply@github.com> 2022-07-27 18:28:38 -0700
commit9e342c17b28643b3a0136ca0befba9b7bffef4af (patch)
tree3c41e60728fc34c107f03fbcd100a75755f5737d
parent9bd4a8f7bbd5f2a308b97cb19ceede5da3cfccee (diff)
downloadbun-9e342c17b28643b3a0136ca0befba9b7bffef4af.tar.gz
bun-9e342c17b28643b3a0136ca0befba9b7bffef4af.tar.zst
bun-9e342c17b28643b3a0136ca0befba9b7bffef4af.zip
docs(macos): Improve MacOS Development Instructions (#836)
* docs(macos): Improve MacOS Development Instructions * Update MacOS zig install to be more automated
-rw-r--r--README.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/README.md b/README.md
index 54f081178..7be3a0fb8 100644
--- a/README.md
+++ b/README.md
@@ -3258,19 +3258,40 @@ which clang-13
If it is not, you will have to run this to link it:
```bash
-export PATH=$(brew --prefix llvm@13)/bin:$PATH
+export PATH="$(brew --prefix llvm@13)/bin:$HOME/.bun-tools/zig:$PATH"
export LDFLAGS="$LDFLAGS -L$(brew --prefix llvm@13)/lib"
export CPPFLAGS="$CPPFLAGS -I$(brew --prefix llvm@13)/include"
```
On fish that looks like `fish_add_path (brew --prefix llvm@13)/bin`
+
+#### Install Zig (macOS)
+
You’ll want to make sure `zig` is in `$PATH`. The specific version of Zig expected is the HEAD in [Jarred-Sumner/zig](https://github.com/Jarred-Sumner/zig).
+If you wan to install the zig binary, follow this script below:
+
+```bash
+# Custom path for the custom zig install
+mkdir -p ~/.bun-tools
+
+# Requires jq & grab latest binary
+curl -o zig.tar.gz -sL https://github.com/oven-sh/zig/releases/download/$(curl -s https://api.github.com/repos/oven-sh/zig/releases/latest | jq '.tag_name' | tr -d '"')/zig-macos-$(uname -m).tar.gz
+
+# This will extract to $HOME/.bun-tools/zig
+tar -xvf zig.tar.gz -C $HOME/.bun-tools/
+
+# Make sure it gets trusted
+xattr -dr com.apple.quarantine .bun-tools/zig/zig
+```
+
#### Build bun (macOS)
If you're building on a macOS device, you'll need to have a valid Developer Certificate, or else the code signing step will fail. To check if you have one, open the `Keychain Access` app, go to the `login` profile and search for `Apple Development`. You should have at least one certificate with a name like `Apple Development: user@example.com (WDYABC123)`. If you don't have one, follow [this guide](https://ioscodesigning.com/generating-code-signing-files/#generate-a-code-signing-certificate-using-xcode) to get one.
+You can still work with the generated binary locally at `packages/debug-bun-*/bun-debug` even if the code signing fails.
+
In `bun`:
```bash