From b140aac6230e14cc72b2944c99b3c3cb1aeb6134 Mon Sep 17 00:00:00 2001 From: hyperpolymath <6759885+hyperpolymath@users.noreply.github.com> Date: Thu, 25 Jun 2026 20:23:47 +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 | 106 ------------------------------------------------ README.md | 115 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 115 insertions(+), 106 deletions(-) delete mode 100644 README.adoc create mode 100644 README.md diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 1b38a86..0000000 --- a/README.adoc +++ /dev/null @@ -1,106 +0,0 @@ -// SPDX-License-Identifier: CC-BY-SA-4.0 -// Copyright (c) Jonathan D.A. Jewell -= RSR Template Repository -:toc: preamble -:icons: font - -image:https://www.bestpractices.dev/projects/{{OPENSSF_PROJECT_ID}}/badge[OpenSSF Best Practices, link="https://www.bestpractices.dev/projects/{{OPENSSF_PROJECT_ID}}"] -image:https://api.securityscorecards.dev/projects/github.com/{{OWNER}}/{{REPO}}/badge[OpenSSF Scorecard, link="https://securityscorecards.dev/viewer/?uri=github.com/{{OWNER}}/{{REPO}}"] - -[NOTE] -==== -This repository is a template. Placeholder tokens like `{{OWNER}}`, `{{REPO}}`, -and `{{PROJECT_NAME}}` are expected before running `just init`. -==== - -== Overview - -This template now uses a split maintenance model: - -* Authoritative session protocols live centrally in `standards/session-management-standards`. -* This repo keeps only thin local integration (Justfile aliases, local hooks, - coordination bindings, and repo-local checks). -* Runtime session artifacts are generated per working repository in `.session/`. - -== Session Management Integration - -Canonical command model: - -* `intake repo ` -* `checkpoint change ` -* `verify maintenance ` -* `verify substantial ` -* `verify release ` -* `close planned ` -* `close urgent ` -* `recover repo ` -* `handover full ` -* `handover split ` -* `handover model ` -* `handover human ` - -Local binding files in this template: - -* `session/dispatch.sh` -* `session/custom-checks.k9` -* `session/local-hooks.sh` -* `session/README.md` -* `coordination.k9` - -Run `just session-help` for local aliases. - -== ABI/FFI Seam Layout - -The template keeps a verified interface seam split: - -* ABI (Idris2): `src/interface/Abi/*.idr` -* FFI (Zig): `src/interface/ffi/src/*.zig` -* Generated artifacts: `src/interface/generated/` - -== Repository Layout - -[cols="1,3"] -|=== -| Path | Purpose - -| `.machine_readable/` -| Machine-readable policy and project metadata. - -| `session/` -| Thin local bindings to central session-management standards. - -| `coordination.k9` -| Local coordination wiring to canonical session commands. - -| `docs/` -| Human-facing technical and governance documentation. - -| `src/interface/` -| ABI/FFI/generated seam scaffolding. - -| `verification/` -| Proof and verification scaffolding. -|=== - -== Quick Start - -[source,bash] ----- -just init -just verify -just session-help ----- - -== Documentation - -* link:AUDIT.adoc[AUDIT.adoc] -- local audit gate summary -* link:EXPLAINME.adoc[EXPLAINME.adoc] -- template claim-to-implementation map -* link:session/README.md[session/README.md] -- session binding usage -* link:docs/governance/README.adoc[docs/governance/README.adoc] -- governance docs index -* link:CONTRIBUTING.md[CONTRIBUTING.md] -* link:SECURITY.md[SECURITY.md] - -== License - -SPDX-License-Identifier: CC-BY-SA-4.0 -See link:LICENSE[LICENSE]. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5c8e3f1 --- /dev/null +++ b/README.md @@ -0,0 +1,115 @@ + + +[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/{{OPENSSF_PROJECT_ID}}/badge)](https://www.bestpractices.dev/projects/{{OPENSSF_PROJECT_ID}}) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/{{OWNER}}/{{REPO}}/badge)](https://securityscorecards.dev/viewer/?uri=github.com/{{OWNER}}/{{REPO}}) + +> [!NOTE] +> This repository is a template. Placeholder tokens like `{{OWNER}}`, +> `{{REPO}}`, and `{{PROJECT_NAME}}` are expected before running `just` +> `init`. + +# Overview + +This template now uses a split maintenance model: + +- Authoritative session protocols live centrally in + `standards/session-management-standards`. + +- This repo keeps only thin local integration (Justfile aliases, local + hooks, coordination bindings, and repo-local checks). + +- Runtime session artifacts are generated per working repository in + `.session/`. + +# Session Management Integration + +Canonical command model: + +- `intake` `repo` `` + +- `checkpoint` `change` `` + +- `verify` `maintenance` `` + +- `verify` `substantial` `` + +- `verify` `release` `` + +- `close` `planned` `` + +- `close` `urgent` `` + +- `recover` `repo` `` + +- `handover` `full` `` + +- `handover` `split` `` + +- `handover` `model` `` + +- `handover` `human` `` + +Local binding files in this template: + +- `session/dispatch.sh` + +- `session/custom-checks.k9` + +- `session/local-hooks.sh` + +- `session/README.md` + +- `coordination.k9` + +Run `just` `session-help` for local aliases. + +# ABI/FFI Seam Layout + +The template keeps a verified interface seam split: + +- ABI (Idris2): `src/interface/Abi/*.idr` + +- FFI (Zig): `src/interface/ffi/src/*.zig` + +- Generated artifacts: `src/interface/generated/` + +# Repository Layout + +| Path | Purpose | +|----|----| +| `.machine_readable/` | Machine-readable policy and project metadata. | +| `session/` | Thin local bindings to central session-management standards. | +| `coordination.k9` | Local coordination wiring to canonical session commands. | +| `docs/` | Human-facing technical and governance documentation. | +| `src/interface/` | ABI/FFI/generated seam scaffolding. | +| `verification/` | Proof and verification scaffolding. | + +# Quick Start + +```bash +just init +just verify +just session-help +``` + +# Documentation + +- AUDIT — local audit gate summary + +- EXPLAINME — template + claim-to-implementation map + +- [session/README.md](session/README.md) — session binding usage + +- [docs/governance/README.adoc](docs/governance/README.adoc) — governance + docs index + +- CONTRIBUTING + +- SECURITY + +# License + +SPDX-License-Identifier: CC-BY-SA-4.0 See [LICENSE](LICENSE).