|
1 | | -= Git Reticulator — EXPLAINME |
2 | | -:toc: preamble |
| 1 | +// SPDX-License-Identifier: PMPL-1.0-or-later |
| 2 | += git-reticulator -- EXPLAINME |
3 | 3 |
|
4 | | -This document backs up the claims made in README with evidence and rationale. |
| 4 | +== "Semantic lattice builder for git repositories in AffineScript" |
5 | 5 |
|
6 | | -== What Is This? |
| 6 | +[quote, Cargo.toml] |
| 7 | +____ |
| 8 | +Semantic lattice builder for git repositories in AffineScript. |
| 9 | +____ |
7 | 10 |
|
8 | | -Git Reticulator is a hyperpolymath project. See README.adoc for usage. |
| 11 | +git-reticulator builds a lattice (partial order) over commits and refs in a |
| 12 | +git repository, using AffineScript's affine-type semantics for safe traversal. |
| 13 | +See `src/lattice/` for the lattice construction and `src/api/` for the REST |
| 14 | +interface. |
9 | 15 |
|
10 | | -== Why These Choices? |
| 16 | +**Caveat:** The README is currently empty beyond the title. The claim above |
| 17 | +comes from `Cargo.toml` -- the lattice module exists but the project is early. |
11 | 18 |
|
12 | | -=== Language |
| 19 | +[cols="1,2", options="header"] |
| 20 | +|=== |
| 21 | +| Path | Proves |
13 | 22 |
|
14 | | -The language(s) used in this project were chosen per the hyperpolymath |
15 | | -language policy (see CLAUDE.md for the full list of allowed/banned languages). |
| 23 | +| `Cargo.toml` |
| 24 | +| Declares the project, its description, and Rust dependencies (actix-web, tokio, clap) |
16 | 25 |
|
17 | | -=== Architecture |
| 26 | +| `src/lattice/` |
| 27 | +| Lattice construction module (affine sub-module for AffineScript integration) |
18 | 28 |
|
19 | | -Architecture decisions are documented in `.machine_readable/` checkpoint files. |
| 29 | +| `src/api/` |
| 30 | +| REST API surface (actix-web) |
20 | 31 |
|
21 | | -== Alternatives Considered |
22 | | - |
23 | | -(To be filled in as the project matures.) |
24 | | - |
25 | | -== Proof of Claims |
26 | | - |
27 | | -(Link formal verification results from the `proven` repo where applicable.) |
| 32 | +| `src/cli/` |
| 33 | +| CLI entry point (clap) |
| 34 | +|=== |
0 commit comments