|
| 1 | +<!-- |
| 2 | +SPDX-License-Identifier: CC-BY-SA-4.0 |
| 3 | +SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk> |
| 4 | +--> |
| 5 | + |
| 6 | +Consolidated monorepo holding Flatracoon’s operating-system and |
| 7 | +networking-stack components, plus the supporting CI / RSR scaffolding. |
| 8 | + |
| 9 | +# Components |
| 10 | + |
| 11 | +- `os/` — operating-system core. The bare-metal / userspace layer of the |
| 12 | + Flatracoon OS proper. |
| 13 | + |
| 14 | +- `netstack/` — independent network stack implementation (sits above or |
| 15 | + alongside `os/`). |
| 16 | + |
| 17 | +Each component is autonomous in its build, but they share licensing, CI, |
| 18 | +and the estate-wide governance bundle inherited from |
| 19 | +`hyperpolymath/standards`. |
| 20 | + |
| 21 | +# Why a monorepo |
| 22 | + |
| 23 | +This repo was consolidated from previously-separate clones into a single |
| 24 | +monorepo to share CI / governance / dependency-version state across the |
| 25 | +two components. Each subdirectory still has its own `Justfile` / |
| 26 | +`Cargo.toml` / build entry points; the monorepo just collapses the |
| 27 | +operational overhead. |
| 28 | + |
| 29 | +# Quickstart |
| 30 | + |
| 31 | +```bash |
| 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 | +``` |
| 43 | + |
| 44 | +# Architecture |
| 45 | + |
| 46 | +See <a href="TOPOLOGY.md" class="md">TOPOLOGY</a> for the visual |
| 47 | +architecture map and the component-by-component completion dashboard. |
| 48 | + |
| 49 | +# Status |
| 50 | + |
| 51 | +- **Licence**: MPL-2.0. See [LICENSE](LICENSE); `LICENSES/` carries the |
| 52 | + full REUSE-compliant set. |
| 53 | + |
| 54 | +- **Estate role**: research / experimental — not yet a downstream |
| 55 | + consumer of stable services. |
| 56 | + |
| 57 | +- **Audit findings**: see `docs/tech-debt-2026-05-26.md` if present |
| 58 | + (added by the 2026-05-26 estate tech-debt scan). |
| 59 | + |
| 60 | +# Contributing |
| 61 | + |
| 62 | +See <a href="CONTRIBUTING.md" class="md">CONTRIBUTING</a>. All commits |
| 63 | +must be GPG-signed and follow conventional-commit conventions |
| 64 | +(estate-wide policy from `hyperpolymath/standards`). |
| 65 | + |
| 66 | +# Companion repositories |
| 67 | + |
| 68 | +- [`hyperpolymath/standards`](https://github.com/hyperpolymath/standards) |
| 69 | + — canonical estate-wide standards. |
| 70 | + |
| 71 | +- [`hyperpolymath/rsr-template-repo`](https://github.com/hyperpolymath/rsr-template-repo) |
| 72 | + — the RSR scaffold this repo follows. |
0 commit comments