chore: Remove deprecated frontmatter reference; add master README template
This commit is contained in:
parent
35f476c2c7
commit
624bd5f8d5
1 changed files with 45 additions and 0 deletions
45
templates/readme-master.md
Normal file
45
templates/readme-master.md
Normal file
|
|
@ -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-<name>
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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.
|
||||||
Loading…
Add table
Reference in a new issue