|
1 | | -= RSR Template Repository |
2 | 1 |
|
3 | | -image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"] |
4 | | -:toc: |
5 | | -:sectnums: |
6 | | - |
7 | | -// Badges |
8 | | -image:https://img.shields.io/badge/RSR-Infrastructure-cd7f32[RSR Infrastructure] |
9 | | -image:https://img.shields.io/badge/Phase-Maintenance-brightgreen[Phase] |
10 | | -image:https://img.shields.io/badge/License-AGPL%20OR%20Palimpsest-blue[License] |
11 | | -image:https://img.shields.io/badge/Guix-Primary-purple?logo=gnu[Guix] |
12 | | - |
13 | | -== Overview |
14 | | - |
15 | | -**The canonical template for RSR (Rhodium Standard Repository) projects.** |
16 | | - |
17 | | -This repository provides the standardized structure, configuration, and tooling for all 139 repos in the hyperpolymath ecosystem. Use it to: |
18 | | - |
19 | | -* Bootstrap new projects with RSR compliance |
20 | | -* Reference the standard directory structure |
21 | | -* Copy configuration templates (justfile, STATE.scm, etc.) |
22 | | - |
23 | | -== Quick Start |
24 | | - |
25 | | -[source,bash] |
26 | | ----- |
27 | | -# Clone the template |
28 | | -git clone https://github.com/hyperpolymath/RSR-template-repo my-project |
29 | | -cd my-project |
30 | | -
|
31 | | -# Remove template git history |
32 | | -rm -rf .git |
33 | | -git init |
34 | | -
|
35 | | -# Customize |
36 | | -sed -i 's/RSR-template-repo/my-project/g' justfile guix.scm README.adoc |
37 | | -
|
38 | | -# Enter development environment |
39 | | -guix shell -D -f guix.scm |
40 | | -
|
41 | | -# Validate compliance |
42 | | -just validate-rsr |
43 | | ----- |
44 | | - |
45 | | -== What's Included |
46 | | - |
47 | | -[cols="1,3"] |
48 | | -|=== |
49 | | -|File/Directory |Purpose |
50 | | - |
51 | | -|`.editorconfig` |
52 | | -|Editor configuration (indent, charset) |
53 | | - |
54 | | -|`.gitignore` |
55 | | -|Standard ignore patterns |
56 | | - |
57 | | -|`.guix-channel` |
58 | | -|Guix channel definition |
59 | | - |
60 | | -|`.well-known/` |
61 | | -|RFC-compliant metadata (security.txt, ai.txt, humans.txt) |
62 | | - |
63 | | -|`docs/` |
64 | | -|Documentation directory |
65 | | - |
66 | | -|`guix.scm` |
67 | | -|Guix package definition |
68 | | - |
69 | | -|`justfile` |
70 | | -|Task runner with 50+ recipes |
71 | | - |
72 | | -|`LICENSE.txt` |
73 | | -|AGPL + Palimpsest dual license |
74 | | - |
75 | | -|`README.adoc` |
76 | | -|This file |
77 | | - |
78 | | -|`RSR_COMPLIANCE.adoc` |
79 | | -|Compliance tracking |
80 | | - |
81 | | -|`STATE.scm` |
82 | | -|Project state checkpoint |
83 | | -|=== |
84 | | - |
85 | | -== Justfile Features |
86 | | - |
87 | | -The template justfile provides: |
88 | | - |
89 | | -* **~10 billion recipe combinations** via matrix recipes |
90 | | -* **Cookbook generation**: `just cookbook` → `docs/just-cookbook.adoc` |
91 | | -* **Man page generation**: `just man` → `docs/man/project.1` |
92 | | -* **RSR validation**: `just validate-rsr` |
93 | | -* **STATE.scm management**: `just state-touch`, `just state-phase` |
94 | | -* **Container support**: `just container-build`, `just container-push` |
95 | | -* **CI matrix**: `just ci-matrix [stage] [depth]` |
96 | | - |
97 | | -=== Key Recipes |
98 | | - |
99 | | -[source,bash] |
100 | | ----- |
101 | | -just # Show all recipes |
102 | | -just help <recipe> # Detailed help |
103 | | -just info # Project info |
104 | | -just combinations # Show matrix options |
105 | | -
|
106 | | -just build # Build (debug) |
107 | | -just test # Run tests |
108 | | -just quality # Format + lint + test |
109 | | -just ci # Full CI pipeline |
110 | | -
|
111 | | -just validate # RSR + STATE validation |
112 | | -just docs # Generate all docs |
113 | | -just cookbook # Generate justfile docs |
114 | | -
|
115 | | -just guix-shell # Guix dev environment |
116 | | -just container-build # Build container |
117 | | ----- |
118 | | - |
119 | | -== Directory Structure |
120 | | - |
121 | | -[source] |
122 | | ----- |
123 | | -project/ |
124 | | -├── .editorconfig # Editor settings |
125 | | -├── .gitignore # Git ignore |
126 | | -├── .guix-channel # Guix channel |
127 | | -├── .well-known/ # RFC metadata |
128 | | -│ ├── ai.txt |
129 | | -│ ├── humans.txt |
130 | | -│ └── security.txt |
131 | | -├── config/ # Nickel configs (optional) |
132 | | -├── docs/ # Documentation |
133 | | -│ ├── generated/ |
134 | | -│ ├── man/ |
135 | | -│ └── just-cookbook.adoc |
136 | | -├── guix.scm # Guix package |
137 | | -├── justfile # Task runner |
138 | | -├── LICENSE.txt # Dual license |
139 | | -├── README.adoc # Overview |
140 | | -├── RSR_COMPLIANCE.adoc # Compliance |
141 | | -├── src/ # Source code |
142 | | -├── STATE.scm # State checkpoint |
143 | | -└── tests/ # Tests |
144 | | ----- |
145 | | - |
146 | | -== RSR Compliance |
147 | | - |
148 | | -=== Language Tiers |
149 | | - |
150 | | -* **Tier 1** (Gold): Rust, Elixir, Zig, Ada, Haskell, ReScript |
151 | | -* **Tier 2** (Silver): Nickel, Racket, Guile Scheme, Nix |
152 | | -* **Infrastructure**: Guix channels, derivations |
153 | | - |
154 | | -=== Required Files |
155 | | - |
156 | | -* `.editorconfig` |
157 | | -* `.gitignore` |
158 | | -* `justfile` |
159 | | -* `README.adoc` |
160 | | -* `RSR_COMPLIANCE.adoc` |
161 | | -* `LICENSE.txt` (AGPL + Palimpsest) |
162 | | -* `.well-known/security.txt` |
163 | | -* `.well-known/ai.txt` |
164 | | -* `.well-known/humans.txt` |
165 | | -* `guix.scm` OR `flake.nix` |
166 | | - |
167 | | -=== Prohibited |
168 | | - |
169 | | -* Python outside `salt/` directory |
170 | | -* TypeScript/JavaScript (use ReScript) |
171 | | -* CUE (use Guile/Nickel) |
172 | | -* `Dockerfile` (use `Containerfile`) |
173 | | - |
174 | | -== STATE.scm |
175 | | - |
176 | | -The STATE.scm file tracks project state: |
177 | | - |
178 | | -[source,scheme] |
179 | | ----- |
180 | | -(define state |
181 | | - `((metadata |
182 | | - (project . "my-project") |
183 | | - (updated . "2025-12-10")) |
184 | | - (position |
185 | | - (phase . implementation) ; design|implementation|testing|maintenance|archived |
186 | | - (maturity . beta)) ; experimental|alpha|beta|production|lts |
187 | | - (ecosystem |
188 | | - (part-of . ("RSR Framework")) |
189 | | - (depends-on . ())))) |
190 | | ----- |
191 | | - |
192 | | -== Badge Schema |
193 | | - |
194 | | -Generate badges from STATE.scm: |
195 | | - |
196 | | -[source,bash] |
197 | | ----- |
198 | | -just badges standard |
199 | | ----- |
200 | | - |
201 | | -See `docs/BADGE_SCHEMA.adoc` for the full badge taxonomy. |
202 | | - |
203 | | -== Ecosystem Integration |
204 | | - |
205 | | -This template is part of: |
206 | | - |
207 | | -* **STATE.scm Ecosystem**: Conversation checkpoints |
208 | | -* **RSR Framework**: Repository standards |
209 | | -* **Consent-Aware-HTTP**: .well-known compliance |
210 | | - |
211 | | -== License |
212 | | - |
213 | | -SPDX-License-Identifier: `AGPL-3.0-or-later OR LicenseRef-Palimpsest-0.5` |
214 | | - |
215 | | -== Links |
216 | | - |
217 | | -* https://github.com/hyperpolymath/elegant-STATE[elegant-STATE] - STATE.scm tooling |
218 | | -* https://github.com/hyperpolymath/conative-gating[conative-gating] - Policy enforcement |
219 | | -* https://rhodium.sh[Rhodium Standard] - RSR documentation |
0 commit comments