From 94f73b80832919c97de48de76cdb8177c89da2de Mon Sep 17 00:00:00 2001 From: hyperpolymath <6759885+hyperpolymath@users.noreply.github.com> Date: Thu, 25 Jun 2026 20:22:54 +0100 Subject: [PATCH] docs(readme): convert README.adoc -> Markdown README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit README must be real Markdown to render in GitHub community-health, the GitHub profile, and external MCP directories (Glama) — AsciiDoc shows as raw markup there. pandoc asciidoc->GFM, badges fixed to clickable, SPDX header kept as an HTML comment, duplicate README.adoc removed. Co-Authored-By: Claude Opus 4.8 --- README.adoc | 70 --------------------------------------------------- README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+), 70 deletions(-) delete mode 100644 README.adoc create mode 100644 README.md diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 832913f..0000000 --- a/README.adoc +++ /dev/null @@ -1,70 +0,0 @@ -// SPDX-License-Identifier: CC-BY-SA-4.0 -// Copyright (c) Jonathan D.A. Jewell -= flatracoon -image:https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=openssourcesecurity[OpenSSF Best Practices,link="https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/flatracoon"] - -:author: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com> -:revdate: 2026-05-26 - -Consolidated monorepo holding Flatracoon's operating-system and -networking-stack components, plus the supporting CI / RSR scaffolding. - -== Components - -* `os/` — operating-system core. The bare-metal / userspace layer of the - Flatracoon OS proper. -* `netstack/` — independent network stack implementation (sits above or - alongside `os/`). - -Each component is autonomous in its build, but they share licensing, CI, -and the estate-wide governance bundle inherited from -`hyperpolymath/standards`. - -== Why a monorepo - -This repo was consolidated from previously-separate clones into a single -monorepo to share CI / governance / dependency-version state across the -two components. Each subdirectory still has its own `Justfile` / -`Cargo.toml` / build entry points; the monorepo just collapses the -operational overhead. - -== Quickstart - -[source,bash] ----- -git clone git@github.com:hyperpolymath/flatracoon.git -cd flatracoon - -# OS: -cd os/ -just build && just test - -# Netstack: -cd ../netstack/ -just build && just test ----- - -== Architecture - -See link:TOPOLOGY.md[TOPOLOGY.md] for the visual architecture map and the -component-by-component completion dashboard. - -== Status - -* **Licence**: MPL-2.0. See link:LICENSE[LICENSE]; `LICENSES/` carries the - full REUSE-compliant set. -* **Estate role**: research / experimental — not yet a downstream - consumer of stable services. -* **Audit findings**: see `docs/tech-debt-2026-05-26.md` if present - (added by the 2026-05-26 estate tech-debt scan). - -== Contributing - -See link:CONTRIBUTING.md[CONTRIBUTING.md]. All commits must be GPG-signed -and follow conventional-commit conventions (estate-wide policy from -`hyperpolymath/standards`). - -== Companion repositories - -* link:https://github.com/hyperpolymath/standards[`hyperpolymath/standards`] — canonical estate-wide standards. -* link:https://github.com/hyperpolymath/rsr-template-repo[`hyperpolymath/rsr-template-repo`] — the RSR scaffold this repo follows. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0227e70 --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ + + +Consolidated monorepo holding Flatracoon’s operating-system and +networking-stack components, plus the supporting CI / RSR scaffolding. + +# Components + +- `os/` — operating-system core. The bare-metal / userspace layer of the + Flatracoon OS proper. + +- `netstack/` — independent network stack implementation (sits above or + alongside `os/`). + +Each component is autonomous in its build, but they share licensing, CI, +and the estate-wide governance bundle inherited from +`hyperpolymath/standards`. + +# Why a monorepo + +This repo was consolidated from previously-separate clones into a single +monorepo to share CI / governance / dependency-version state across the +two components. Each subdirectory still has its own `Justfile` / +`Cargo.toml` / build entry points; the monorepo just collapses the +operational overhead. + +# Quickstart + +```bash +git clone git@github.com:hyperpolymath/flatracoon.git +cd flatracoon + +# OS: +cd os/ +just build && just test + +# Netstack: +cd ../netstack/ +just build && just test +``` + +# Architecture + +See TOPOLOGY for the visual +architecture map and the component-by-component completion dashboard. + +# Status + +- **Licence**: MPL-2.0. See [LICENSE](LICENSE); `LICENSES/` carries the + full REUSE-compliant set. + +- **Estate role**: research / experimental — not yet a downstream + consumer of stable services. + +- **Audit findings**: see `docs/tech-debt-2026-05-26.md` if present + (added by the 2026-05-26 estate tech-debt scan). + +# Contributing + +See CONTRIBUTING. All commits +must be GPG-signed and follow conventional-commit conventions +(estate-wide policy from `hyperpolymath/standards`). + +# Companion repositories + +- [`hyperpolymath/standards`](https://github.com/hyperpolymath/standards) + — canonical estate-wide standards. + +- [`hyperpolymath/rsr-template-repo`](https://github.com/hyperpolymath/rsr-template-repo) + — the RSR scaffold this repo follows.