Guides
The documents of the repository: how each part of the system is designed, and why. The tables of what exists are in the reference.
| Guide | What it holds | File |
|---|---|---|
| Kernel properties | The properties that the system is built on | docs/PROPERTIES.md |
| Architecture | The key systems and how they connect | docs/ARCHITECTURE.md |
| Module contract | The module format, the loader and the call form | docs/MODULE_CONTRACT.md |
| First milestone | What the code does now, the choices made, the gaps | docs/FIRST_MILESTONE.md |
| Developer tools | The developer tools, and what each one reads | docs/TOOLS.md |
| The site | The site of the system: what kerneltool site writes, and where each part of the page comes from | docs/SITE.md |
| The design rules | The design rules: how a program of the system looks. The boot display is the model | docs/DESIGN.md |
| Pointer pictures | The pointer pictures: Xcursor, hyprcursor and the others; the format and the manifest of the system; the license of the theme of the owner | docs/POINTERS.md |
| The demonstration of each property | For each of the 21 properties: what the machine test shows, the picture, and what no test shows yet | docs/DEMONSTRATIONS.md |
| The line of the console | docs/CONSOLE.md | |
| Cryptography | docs/CRYPTOGRAPHY.md | |
| The text of the system: a vector font with subpixel bands | docs/FONTS.md | |
| The interface of the programs | docs/INTERFACE.md | |
| The network: TCP as a library in the program | docs/NETWORK.md | |
| QUIC | docs/QUIC.md | |
| Randomness | docs/RANDOMNESS.md | |
| One source, one module: the build and the threads of the compiler | docs/REPRODUCIBLE_BUILD.md | |
| Scheduling strategies | docs/SCHEDULING.md | |
| Vector forms: SSE2 | docs/SIMD.md |
Read from README.md.
