Skip to content

Commit a1ee988

Browse files
hyperpolymathclaude
andcommitted
docs: add EXPLAINME.adoc — prove-it file backing README claims
Standard RSR documentation: quotes README claims, lists tech choices with links, honest caveats, dogfooding table. See rsr-template-repo for the pattern. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 5c39a1d commit a1ee988

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

EXPLAINME.adoc

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
// SPDX-License-Identifier: PMPL-1.0-or-later
2+
= Developer Ecosystem — Show Me The Receipts
3+
:toc:
4+
:icons: font
5+
6+
The README makes claims. This file backs them up.
7+
8+
[quote, README]
9+
____
10+
This project must declare **MPL-2.0-or-later** for platform/tooling compatibility.
11+
____
12+
13+
== Technology Choices
14+
15+
[cols="1,2"]
16+
|===
17+
| Technology | Learn More
18+
19+
| **Zig** | https://ziglang.org
20+
| **Idris2 ABI** | https://www.idris-lang.org
21+
|===
22+
23+
== Dogfooded Across The Account
24+
25+
Uses the hyperpolymath ABI/FFI standard (Idris2 + Zig). Same pattern used across
26+
https://github.com/hyperpolymath/proven[proven],
27+
https://github.com/hyperpolymath/burble[burble], and
28+
https://github.com/hyperpolymath/gossamer[gossamer].
29+
30+
== File Map
31+
32+
[cols="1,2"]
33+
|===
34+
| Path | What's There
35+
36+
| `src/` | Source code
37+
| `lib/` | Library code
38+
| `ffi/` | Foreign function interface
39+
| `test(s)/` | Test suite
40+
|===
41+
42+
== Questions?
43+
44+
Open an issue or reach out directly — happy to explain anything in more detail.

0 commit comments

Comments
 (0)