Skip to content

Commit 787d434

Browse files
Streamline README and add focused documentation (#91)
* docs: streamline README and add focused guides * docs: preserve retained README sections * docs: tighten launch claims and provenance * docs: add README hero banner
1 parent 1054238 commit 787d434

5 files changed

Lines changed: 471 additions & 277 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@ Premove ITN has one production path: Rust candidate generation, contextual
44
scoring, and exact decoding behind the `PremoveITN` Python API and CLI. Keep
55
changes focused and preserve this boundary.
66

7+
## Repository layout
8+
9+
| Path | Purpose |
10+
| --- | --- |
11+
| `src/premove_itn/` | Python runtime and public API |
12+
| `rust/` | Deterministic realization rules |
13+
| `benchmarks/` | Optional comparison and artifact-verification tools |
14+
| `eval/` | Frozen benchmark and retained results |
15+
| `examples/` | Minimal Python and stdin examples |
16+
| `scripts/` | Release checks and development utilities |
17+
| `tests/` | Python regression tests |
18+
| `docs/` | Architecture, provenance, and evaluation documentation |
19+
720
## Pull requests
821

922
Create a short-lived branch from `main` and open one focused pull request.

PremoveITN.png

135 KB
Loading

0 commit comments

Comments
 (0)