Update Docs

This commit is contained in:
Raven Scott
2026-04-06 06:44:15 -04:00
parent 6d0d1b8049
commit f0fb05274b
21 changed files with 573 additions and 17 deletions
@@ -2,6 +2,10 @@
**Prerequisites:** [Install and repository layout](02-install-and-repository-layout.md). **Time to read:** about seven minutes.
**Canonical refs:** [Compatibility matrix](../docs/reference/compatibility-matrix.md) · [Environment appendix](../docs/reference/environment-and-posix-appendix.md).
**One-page quick path:** [Get started](../docs/get-started.md) (prerequisites table, success criteria, failure matrix).
---
## On this page
@@ -38,6 +42,13 @@ flowchart LR
## Run with Node (quick path)
<details>
<summary><strong>When to expand this block</strong></summary>
Use **Node** when you do not have Pear installed or you are bisecting protocol and seeding bugs with host stack traces identical to your toolchain. **Pear** is still the closest match to embedded / released apps (`npm run os:*`).
</details>
Run the seeder from its package directory so **`kernel/`** resolves correctly from the repo layout:
```bash
@@ -58,6 +69,13 @@ On a **fresh clone**, build **`kernel/bin/*`** and **`kernel/lib/bare/`** before
## Run with Pear (recommended for realistic behavior)
<details>
<summary><strong>When to expand this block</strong></summary>
**Pear** exercises **`pear run --dev`**, hoisted **`node_modules`**, and **`BARE_OS_PEAR_*`** behavior. Install the [Pear CLI](https://docs.pears.com/) first; confirm with **`pear --version`**.
</details>
From the **repository root**:
```bash
@@ -112,6 +130,7 @@ Canonical **booter boot steps** (**`vfs`** → **`ctx`** → **`repl`** → **`i
## Related reading
- [Get started](../docs/get-started.md)
- [docs/troubleshooting.md](../docs/troubleshooting.md)
- [Handbook — Protocol and disk](../handbook/03-protocol-and-disk.md)