💄 format build docs

Author: rauhryan

BUILD.md

@@ -3,6 +3,7 @@
 This guide is for maintainers and builders working on clayterm itself.
 
 It covers:
+
 - cloning the repo correctly,
 - initializing the `clay` git submodule,
 - installing the toolchain needed to compile the C sources to WebAssembly,
@@ -16,6 +17,7 @@ It does **not** cover npm/JSR packaging or publishing.
 The local source build is driven by `make`.
 
 It generates:
+
 - `clayterm.wasm` — the compiled WebAssembly module built from the C sources
 - `wasm.ts` — a generated TypeScript file derived from `clayterm.wasm`
 
@@ -44,11 +46,13 @@ Quick check:
 git submodule status --recursive
 ```
 
-You should also see a populated `clay/` directory. If `clay/` is missing or empty, fix the submodule state before building.
+You should also see a populated `clay/` directory. If `clay/` is missing or
+empty, fix the submodule state before building.
 
 ## Required tools
 
 You need:
+
 - `git`
 - `make`
 - `clang` with wasm32-capable support
@@ -60,7 +64,8 @@ Equivalent packages are fine if your package manager uses different names.
 
 ### macOS
 
-Install Apple's command line tools first. They provide the base developer tools, including `git` and `make`.
+Install Apple's command line tools first. They provide the base developer tools,
+including `git` and `make`.
 
 ```sh
 xcode-select --install
@@ -79,7 +84,8 @@ echo 'export PATH="$(brew --prefix llvm)/bin:$PATH"' >> ~/.zshrc
 source ~/.zshrc
 ```
 
-If you do not already have `git` available after installing the command line tools, install it with Homebrew:
+If you do not already have `git` available after installing the command line
+tools, install it with Homebrew:
 
 ```sh
 brew install git
@@ -138,9 +144,11 @@ From an elevated PowerShell prompt:
 wsl --install -d Ubuntu
 ```
 
-Then open the Ubuntu environment and follow the **Debian / Ubuntu** instructions above.
+Then open the Ubuntu environment and follow the **Debian / Ubuntu** instructions
+above.
 
-The build host runs inside WSL2, but the resulting WebAssembly artifacts are intended to run on **native Windows** at runtime.
+The build host runs inside WSL2, but the resulting WebAssembly artifacts are
+intended to run on **native Windows** at runtime.
 
 ## Verify the toolchain
 
@@ -160,7 +168,9 @@ clang --target=wasm32 -c -x c /dev/null -o /tmp/clayterm-wasm-test.o
 rm -f /tmp/clayterm-wasm-test.o
 ```
 
-On macOS, if `which clang` still points to `/usr/bin/clang` and the wasm test fails, make sure the Homebrew LLVM `bin/` directory is at the front of your `PATH`.
+On macOS, if `which clang` still points to `/usr/bin/clang` and the wasm test
+fails, make sure the Homebrew LLVM `bin/` directory is at the front of your
+`PATH`.
 
 ## Build from source
 
@@ -171,6 +181,7 @@ make
 ```
 
 This should produce:
+
 - `clayterm.wasm`
 - `wasm.ts`
 
@@ -183,6 +194,7 @@ make clean && make
 ## When to rebuild
 
 Re-run `make` when:
+
 - you change files under `src/`
 - you update the `clay` submodule
 - `clayterm.wasm` or `wasm.ts` is missing
@@ -214,6 +226,7 @@ deno lint
 ### `clay/` is missing or empty
 
 Symptoms may include build failures such as:
+
 - `fatal error: '../clay/clay.h' file not found`
 
 Recovery:
@@ -232,10 +245,12 @@ make clean && make
 ### `clang` cannot target `wasm32`
 
 Symptoms may include:
+
 - target-related `clang` errors mentioning `wasm32`
 - linker failures while producing `clayterm.wasm`
 
 Recovery:
+
 - make sure you are using an LLVM/Clang build with wasm support
 - on macOS, prefer the Homebrew `llvm` toolchain over `/usr/bin/clang`
 - on Linux/WSL2, make sure both `clang` and `lld` are installed
@@ -251,6 +266,7 @@ If the smoke test fails, fix the toolchain first and only then rerun `make`.
 ### Generated artifacts are missing or stale
 
 Symptoms may include:
+
 - `clayterm.wasm` is missing
 - `wasm.ts` is missing
 - you changed `src/` or updated `clay/`, but the generated outputs do not match
@@ -272,6 +288,7 @@ deno task test
 This document is intentionally limited to local source builds for development.
 
 Out of scope:
+
 - `deno task build:npm`
 - `deno task build:jsr`
 - `npm publish`

README.md

@@ -212,7 +212,8 @@ process.stdin.on("data", (buf) => {
 
 ## Development
 
-For local source builds, toolchain setup, and `clay` submodule instructions, see [BUILD.md](BUILD.md).
+For local source builds, toolchain setup, and `clay` submodule instructions, see
+[BUILD.md](BUILD.md).
 
 Quick local validation: