diff --git a/templates/readme-master.md b/templates/readme-master.md new file mode 100644 index 0000000..f8ad347 --- /dev/null +++ b/templates/readme-master.md @@ -0,0 +1,45 @@ +# {{MASTER_REPO}} + +Master (umbrella) repository for the Knowledge Genome network. + +| Field | Value | +| ---------- | -------------------------------------------------- | +| Owner | `{{FORGEJO_USER}}` | +| Remote | `{{FORGEJO_URL}}/{{FORGEJO_USER}}/{{MASTER_REPO}}` | +| Scaffolded | `{{DATE}}` | + +## What this repo is + +This repository does **not** hold knowledge itself. It is the orchestrator: each genome +is a Git submodule, plus `core-karpathy` as a read-only reference pattern. Cross-genome +coordination rules live in `AGENTS.md`. + +```text +{{MASTER_REPO}}/ +├── core-karpathy/ ← reference pattern — read-only, never modify +├── genome-*/ ← one submodule per genome (own AGENTS.md, own git-crypt) +└── AGENTS.md ← cross-genome coordinator (boundaries only) +``` + +## Working with submodules + +```bash +# Clone with all genomes +git clone --recurse-submodules {{FORGEJO_URL}}/{{FORGEJO_USER}}/{{MASTER_REPO}}.git + +# Pull the latest pointers for every genome +git submodule update --remote --merge + +# Operate inside a single genome (one genome at a time — see AGENTS.md) +cd genome- +``` + +## Rules of the road + +- Operate within **one genome at a time**; no commits spanning multiple genomes. +- `core-karpathy` is read-only. +- Never commit to `main` in a genome — PRs only, no self-merge. +- Private data (`**/private/**`) is git-crypt encrypted and never leaves the local network. + +Genome-level operations are governed by each genome's own `AGENTS.md`. This README and the +master `AGENTS.md` govern boundaries only.