diff --git a/docs/README.md b/docs/README.md index 0392640..c3e5631 100644 --- a/docs/README.md +++ b/docs/README.md @@ -85,6 +85,10 @@ Start with the north star: Cutting across all of these: +- **[system-requirements.md](system-requirements.md) — system requirements.** The + hardware needed to run danos: minimum specs (UEFI x86-64, ACPI, PCIe ECAM, + xHCI, ~128 MiB RAM) grounded in what the boot path actually assumes, plus a + plain-language guide matching Intel/AMD CPU generations by name. - **[arch.md](arch.md) — the architecture split.** How CPU-specific code is kept behind a build-time `arch` module so the generic kernel never names x86_64, leaving room for other systems (e.g. an AArch64 Raspberry Pi) later. @@ -153,7 +157,7 @@ addressed as **`system/services/init`** — the repeated leaf resolves away: | Source (root file) | Addressed as (module / binary / FHS path) | |----------------------------------------|--------------------------------------------| | `system/services/init/init.zig` | `system/services/init` → `/system/services/init` | -| `system/drivers/hpet/hpet.zig` | `system/drivers/hpet` → `/system/drivers/hpet` | +| `system/drivers/ps2-bus/ps2-bus.zig` | `system/drivers/ps2-bus` → `/system/drivers/ps2-bus` | | `library/runtime/runtime.zig` | `library/runtime` (the `runtime` module) | In **source**, a sub-project is a directory so it can hold many files — the entry is @@ -219,6 +223,6 @@ appears in the private-ABI path. | danos-native runtime (`runtime`): syscall wrappers, heap, IPC, device access — the stable application ABI | `library/runtime/` | | POSIX/C compatibility (`posix`): unistd, stdio — the one place POSIX names are allowed | `library/posix/` | | System services (init, the VFS server + `protocol`, the device-manager) | `system/services/` | -| Device drivers, one sub-project each (`hpet` leaf driver, `bus` bus driver) | `system/drivers/` | +| Device drivers, one sub-project each (`pci-bus`, `ps2-bus`, `usb-xhci-bus` bus drivers) | `system/drivers/` | | Build + `run-x86-64` (QEMU/OVMF) | `build.zig` | | QEMU integration test harness | `test/qemu_test.py` |