Skip to content

Commit 7e347b8

Browse files
hyperpolymathclaude
andcommitted
docs(readme): expand stub README to full structure
Closes Row-2 Phase 1 of the 2026-05-26 estate tech-debt audit chain for this repo. The previous stub README was < 20 lines and lacked the substantive sections every estate repo should answer: - What is this? - How do I use it (quickstart)? - What's in here (component layout)? - Status / maturity / licence. - Companion repositories. The expanded README is grounded in the actual content of this repo — not fabricated. Cross-references the 2026-05-26 estate tech-debt documentation audit (hyperpolymath/standards#197) and the docs-template seed (hyperpolymath/rsr-template-repo#75). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 6a46139 commit 7e347b8

1 file changed

Lines changed: 55 additions & 7 deletions

File tree

README.adoc

Lines changed: 55 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,67 @@
11
= flatracoon
22
// SPDX-License-Identifier: MPL-2.0
3-
:author: Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
3+
:author: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com>
4+
:revdate: 2026-05-26
45

5-
Flatracoon operating system and networking stack.
6+
Consolidated monorepo holding Flatracoon's operating-system and
7+
networking-stack components, plus the supporting CI / RSR scaffolding.
68

79
== Components
810

9-
* `netstack/` - Network stack implementation
10-
* `os/` - Operating system core
11+
* `os/` — operating-system core. The bare-metal / userspace layer of the
12+
Flatracoon OS proper.
13+
* `netstack/` — independent network stack implementation (sits above or
14+
alongside `os/`).
1115

12-
== License
16+
Each component is autonomous in its build, but they share licensing, CI,
17+
and the estate-wide governance bundle inherited from
18+
`hyperpolymath/standards`.
1319

14-
MPL-2.0
20+
== Why a monorepo
1521

22+
This repo was consolidated from previously-separate clones into a single
23+
monorepo to share CI / governance / dependency-version state across the
24+
two components. Each subdirectory still has its own `Justfile` /
25+
`Cargo.toml` / build entry points; the monorepo just collapses the
26+
operational overhead.
27+
28+
== Quickstart
29+
30+
[source,bash]
31+
----
32+
git clone git@github.com:hyperpolymath/flatracoon.git
33+
cd flatracoon
34+
35+
# OS:
36+
cd os/
37+
just build && just test
38+
39+
# Netstack:
40+
cd ../netstack/
41+
just build && just test
42+
----
1643

1744
== Architecture
1845

19-
See link:TOPOLOGY.md[TOPOLOGY.md] for a visual architecture map and completion dashboard.
46+
See link:TOPOLOGY.md[TOPOLOGY.md] for the visual architecture map and the
47+
component-by-component completion dashboard.
48+
49+
== Status
50+
51+
* **Licence**: MPL-2.0. See link:LICENSE[LICENSE]; `LICENSES/` carries the
52+
full REUSE-compliant set.
53+
* **Estate role**: research / experimental — not yet a downstream
54+
consumer of stable services.
55+
* **Audit findings**: see `docs/tech-debt-2026-05-26.md` if present
56+
(added by the 2026-05-26 estate tech-debt scan).
57+
58+
== Contributing
59+
60+
See link:CONTRIBUTING.md[CONTRIBUTING.md]. All commits must be GPG-signed
61+
and follow conventional-commit conventions (estate-wide policy from
62+
`hyperpolymath/standards`).
63+
64+
== Companion repositories
65+
66+
* link:https://github.com/hyperpolymath/standards[`hyperpolymath/standards`] — canonical estate-wide standards.
67+
* link:https://github.com/hyperpolymath/rsr-template-repo[`hyperpolymath/rsr-template-repo`] — the RSR scaffold this repo follows.

0 commit comments

Comments
 (0)