diff options
| author |  dave caruso <me@paperdave.net>
| 2023-04-08 23:05:05 -0400 |
|---|---|---|
| committer |  Dylan Conway <dylan.conway567@gmail.com>
| 2023-04-10 11:58:19 -0700 |
| commit | 501089f525641166d23d6913f9f7582f7627087c (patch) | |
| tree | 5ea1f2f5173abc4cf5072ae80543c09bf80db294 | |
| parent | fc07f76774bb65b3348756672fefb301f5a484e3 (diff) | |
| download | bun-501089f525641166d23d6913f9f7582f7627087c.tar.gz bun-501089f525641166d23d6913f9f7582f7627087c.tar.zst bun-501089f525641166d23d6913f9f7582f7627087c.zip | |
Fix callout tag on development docs (#2595)
* fix callout tag on development docs
* add notes on cmakeconfig.h
* Update Makefile
| -rw-r--r-- | Makefile | 8 | ||||
| -rw-r--r-- | docs/project/development.md | 23 |
2 files changed, 25 insertions, 6 deletions
@@ -1858,10 +1858,10 @@ regenerate-bindings: .PHONY: setup setup: require - # make init-submodules - # cd test && $(NPM_CLIENT) install --production - # cd packages/bun-types && $(NPM_CLIENT) install --production - # make vendor-without-check builtins identifier-cache clean-bindings + make init-submodules + cd test && $(NPM_CLIENT) install --production + cd packages/bun-types && $(NPM_CLIENT) install --production + make vendor-without-check builtins identifier-cache clean-bindings make bindings -j$(CPU_COUNT) @echo "" @echo "Development environment setup complete" diff --git a/docs/project/development.md b/docs/project/development.md index 3a0637b26..557809918 100644 --- a/docs/project/development.md +++ b/docs/project/development.md @@ -15,7 +15,7 @@ $ brew install llvm@15 ```bash#Ubuntu/Debian # On Ubuntu 22.04 and newer, LLVM 15 is available in the default repositories $ sudo apt install llvm-15 lld-15 -# On older versions, +# On older versions, $ wget https://apt.llvm.org/llvm.sh -O - | sudo bash -s -- 15 all ``` @@ -114,7 +114,7 @@ That inlines the JavaScript code into C++ headers using the same builtins genera {% callout %} Make sure you have `ccache` installed, otherwise regeneration will take much longer than it should. -{% endcallout %} +{% /callout %} ## Code generation scripts @@ -255,14 +255,33 @@ $ bun-debug ## Troubleshooting +### libarchive + If you see an error when compiling `libarchive`, run this: ```bash $ brew install pkg-config ``` +### missing files on `zig build obj` + If you see an error about missing files on `zig build obj`, make sure you built the headers. ```bash $ make headers ``` + +### cmakeconfig.h not found + +If you see an error about `cmakeconfig.h` not being found, this is because the precompiled WebKit did not install properly. + +```bash +$ bun install +``` + +Check to see the command installed webkit, and you can manully look for `node_modules/bun-webkit-{platform}-{arch}`: + +```bash +# this should reveal two directories. if not, something went wrong +$ echo node_modules/bun-webkit* +``` |