aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-08-28 13:05:23 -0700
committerGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-08-28 13:05:23 -0700
commita2aad40171292914bef924f12172ae00049fcef4 (patch)
treef38fc71207e9686991e76efa97d1401859b37008
parent177e02b304d331b5a3142d5e52d22fb368c4f33e (diff)
downloadbun-a2aad40171292914bef924f12172ae00049fcef4.tar.gz
bun-a2aad40171292914bef924f12172ae00049fcef4.tar.zst
bun-a2aad40171292914bef924f12172ae00049fcef4.zip
docs: use table tag
-rw-r--r--docs/project/development.md148
1 files changed, 122 insertions, 26 deletions
diff --git a/docs/project/development.md b/docs/project/development.md
index b148d2b8e..c253b4381 100644
--- a/docs/project/development.md
+++ b/docs/project/development.md
@@ -144,35 +144,131 @@ $ make assert-deps submodule npm-install-dev node-fallbacks runtime_js fallback_
Bun uses a series of make commands to rebuild parts of the codebase. The general rule for rebuilding is there is `make link` to rerun the linker, and then different make targets for different parts of the codebase. Do not pass `-j` to make as these scripts will break if run out of order, and multiple cores will be used when possible during the builds.
-| What changed | Run this command |
-| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Zig Code | `make zig` |
-| C++ Code | `make cpp` |
-| Zig + C++ Code | `make dev` (combination of the above two) |
-| JS/TS Code in `src/js` | `make js` (in bun-debug, js is loaded from disk without a recompile). If you change the names of any file or add/remove anything, you must also run `make dev`. |
-| `*.classes.ts` | `make generate-classes dev` |
-| JSSink | `make generate-sink cpp` |
-| `src/node_fallbacks/*` | `make node-fallbacks zig` |
-| `identifier_data.zig` | `make identifier-cache zig` |
-| Code using `cppFn`/`JSC.markBinding` | `make headers` (TODO: explain explain what this is used for and why it's useful) |
+{% table %}
+
+- What changed
+- Run this command
+
+---
+
+- Zig Code
+- `make zig`
+
+---
+
+- C++ Code
+- `make cpp`
+
+---
+
+- Zig + C++ Code
+- `make dev` (combination of the above two)
+
+---
+
+- JS/TS Code in `src/js`
+- `make js` (in bun-debug, js is loaded from disk without a recompile). If you change the names of any file or add/remove anything, you must also run `make dev`.
+
+---
+
+- `*.classes.ts`
+- `make generate-classes dev`
+
+---
+
+- JSSink
+- `make generate-sink cpp`
+
+---
+
+- `src/node_fallbacks/*`
+- `make node-fallbacks zig`
+
+---
+
+- `identifier_data.zig`
+- `make identifier-cache zig`
+
+---
+
+- Code using `cppFn`/`JSC.markBinding`
+- `make headers` (TODO: explain explain what this is used for and why it's useful)
+
+{% /table %}
`make setup` cloned a bunch of submodules and built the subprojects. When a submodule is out of date, run `make submodule` to quickly reset/update all your submodules, then you can rebuild individual submodules with their respective command.
-| Dependency | Run this command |
-| -------------- | ---------------------------------------- |
-| WebKit | `bun install` (it is a prebuilt package) |
-| uWebSockets | `make uws` |
-| Mimalloc | `make mimalloc` |
-| PicoHTTPParser | `make picohttp` |
-| zlib | `make zlib` |
-| BoringSSL | `make boringssl` |
-| libarchive | `make libarchive` |
-| lolhtml | `make lolhtml` |
-| sqlite | `make sqlite` |
-| TinyCC | `make tinycc` |
-| c-ares | `make c-ares` |
-| zstd | `make zstd` |
-| Base64 | `make base64` |
+{% table %}
+
+- Dependency
+- Run this command
+
+---
+
+- WebKit
+- `bun install` (it is a prebuilt package)
+
+---
+
+- uWebSockets
+- `make uws`
+
+---
+
+- Mimalloc
+- `make mimalloc`
+
+---
+
+- PicoHTTPParser
+- `make picohttp`
+
+---
+
+- zlib
+- `make zlib`
+
+---
+
+- BoringSSL
+- `make boringssl`
+
+---
+
+- libarchive
+- `make libarchive`
+
+---
+
+- lolhtml
+- `make lolhtml`
+
+---
+
+- sqlite
+- `make sqlite`
+
+---
+
+- TinyCC
+- `make tinycc`
+
+---
+
+- c-ares
+- `make c-ares`
+
+---
+
+- zstd
+- `make zstd`
+
+---
+
+- Base64
+- `make base64`
+
+{% /table %}
The above will probably also need Zig and/or C++ code rebuilt.