nexoniarz/SchOS
nexoniarz/SchOS
Watch
1
0
Fork
You've already forked SchOS
 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: README, plan, guides and the site describe what is built now

Browse source 
README: rewritten around what runs (Linux software, Xorg, apk, Linux's drivers), the honest gaps, measured numbers.
plan/: 1.0.md is the finish line, where each clause of the acceptance test stands, and the register (one failing
clause: a root that survives a reboot); built plans (foundations, hybrid, alpine, xorg) and the decided-against one
(wayland) are gone, their content lives in architecture/; roadmap.md is only what is still open.
guides: building/layout/testing/adding-a-driver (Linux code may be used). history: four entries (ls -lR, TLB
shootdowns, MDIO 0x02460246, netlink MSG_TRUNC). Website: cards, stack, download page, docs index.
Code comments that pointed at deleted plan docs point at the architecture docs.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EVRhxi9zpdW2uDUN4FVcao
This commit is contained in:
Nexoniarz 2026-10-26 08:08:05 +01:00
commit cb3d28e3d6
57 changed files with 685 additions and 2121 deletions
Download patch file Download diff file Expand all files Collapse all files

32
projects/README.md
View file

@ -27,18 +27,14 @@ Concretely, code in here:
| Directory | What it is |
|------------|-----------------------------------------------------------------|
| `schcom/` | SchOS Compositor. Owns the display, composites clients, routes input. |
| `schcom/` | SchOS Compositor v0. Superseded by Xorg; awaiting deletion (see Status). |
| `schinst/` | The installer, the installation environment, and `.sip` tooling. |
| `schfs-linux/` | SchFS as a filesystem for Linux. FUSE first, a kernel module later. |
`schwm/` and `schde/` used to be here and have been **deleted**. In Wayland the
compositor *is* the window manager — there is no protocol by which a second
process places another's windows — and a panel or a launcher is an ordinary
client that needs no home of its own until one is written. Both directories held
a README and no code, and both had said "to be deleted" for long enough to prove
that a directory marked for deletion is not deleted by being marked. What they
argued for survives as a module boundary inside Schcom; see
[`docs/plan/wayland.md`](../docs/plan/wayland.md).
`schwm/` and `schde/` used to be here and have been **deleted**: both held a README and no code, and both
had said "to be deleted" for long enough to prove that a directory marked for deletion is not deleted by being
marked. The desktop is Xorg with Window Maker ([`docs/architecture/desktop.md`](../docs/architecture/desktop.md)),
so the window manager is someone else's and a panel or launcher is an ordinary client.
**`schfs-linux/` is written to stand on its own.** It does not mention SchOS
anywhere, and that is deliberate rather than an oversight: it is intended to be
@ -55,17 +51,9 @@ by anything above it.
## Status
`schcom/` has a v0: 715 lines that run, over a wire format of its own. **That
wire format is superseded** — the compositor moves onto Wayland, keeping the
architecture and replacing the protocol. See
[`docs/plan/wayland.md`](../docs/plan/wayland.md).
`schcom/` is a compositor v0, 715 lines that run, over a wire format of its own. **It is superseded**: the desktop is
Xorg on the framebuffer, not a compositor of ours, and nothing speaks Schcom's protocol. It is on the register in
[`docs/plan/1.0.md`](../docs/plan/1.0.md) as *built and not connected*: delete it, or say what it is for.
Everything Schcom was blocked on in the kernel now exists: unix domain sockets,
raw input events, shared memory, framebuffer `mmap`, and — as of the descriptor
passing work — `SCM_RIGHTS`, which is the one thing a Wayland client cannot be
written without. What is still missing is a **shareable memory object**, item 2
of [`docs/plan/foundations.md`](../docs/plan/foundations.md): a Wayland buffer
is a file descriptor for memory, and a System V segment id is not one.
`schinst/` and `schfs-linux/` are scoped and unstarted, and are **frozen** —
see [`docs/plan/1.0.md`](../docs/plan/1.0.md).
`schinst/` and `schfs-linux/` are scoped and unstarted, and are **frozen** -- see
[`docs/plan/1.0.md`](../docs/plan/1.0.md).