Skip to content

Commit 307d672

Browse files
docs(readme): convert README.adoc -> Markdown (renders on Glama/profile/community-health) (#110)
README was AsciiDoc → renders as raw markup in Markdown consumers (Glama MCP directory, GitHub community-health, GitHub profile). pandoc asciidoc→GFM (badges → clickable), SPDX header kept, duplicate `.adoc` removed. Part of the estate README-format fix. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 133f70e commit 307d672

2 files changed

Lines changed: 149 additions & 130 deletions

File tree

README.adoc

Lines changed: 0 additions & 130 deletions
This file was deleted.

README.md

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
<!--
2+
SPDX-License-Identifier: CC-BY-SA-4.0
3+
SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
4+
-->
5+
6+
[![License: MPL-2.0](https://img.shields.io/badge/License-MPL--2.0-brightgreen.svg)](https://www.mozilla.org/en-US/MPL/2.0/) :toc: macro :toclevels: 3 :icons: font
7+
8+
A full-stack, open-source paradigm for building verifiably-compliant,
9+
secure, and sustainable systems.
10+
11+
<div id="toc">
12+
13+
</div>
14+
15+
# Status
16+
17+
> [!IMPORTANT]
18+
> **Early implementation** — Specification uploads still pending
19+
> (ROADMAP Phase 1).
20+
>
21+
> This repository serves as the official hub and governance center for
22+
> the MAA Framework project. Implementation work lives in-tree under
23+
> `aletheia/` (the microkernel, Rust); the Certified Null Operation is
24+
> the standalone `hyperpolymath/absolute-zero` repository, coordinated
25+
> here (referenced, not vendored as a submodule). A CRG Tier-C test
26+
> suite (unit, E2E, property, aspect, benchmarks) landed 2026-04-04.
27+
> Detailed specification documents will be uploaded as development
28+
> progresses.
29+
30+
# Overview
31+
32+
The MAA Framework is an integrated ecosystem comprising:
33+
34+
| Component | Description |
35+
|----|----|
36+
| **MAA Framework** | Full-stack paradigm for verifiably-compliant, secure, sustainable systems |
37+
| **Oblíbený** | Reference language designed for the framework |
38+
| **Aletheia** | Microkernel implementation |
39+
40+
# Project Scope
41+
42+
The framework addresses the following domains:
43+
44+
- **Security & Formal Verification** — Provable correctness guarantees
45+
46+
- **AI Ethics & Axiology** — Value-aligned system design
47+
48+
- **Dependability** — Fault-tolerant, reliable computing
49+
50+
- **Language Design & Compilers** — Purpose-built toolchains
51+
52+
- **Microkernel Architecture** — Minimal trusted computing base
53+
54+
- **RISC-V** — Open hardware architecture support
55+
56+
- **Sustainability** — Resource-efficient computing
57+
58+
- **Economics-as-Code** — Programmable economic primitives
59+
60+
- **Distributed Computing** — BOINC-compatible workloads
61+
62+
- **Reversibility** — Turing-complete/incomplete computation models
63+
64+
- **Web Protocols** — Modern network standards
65+
66+
# Repository Contents
67+
68+
## Currently Available
69+
70+
.
71+
├── .claude/CLAUDE.md # Language policy (Hyperpolymath Standard)
72+
├── .github/
73+
│ ├── CODEOWNERS # Maintainer assignments
74+
│ └── workflows/ # CI wrappers + multi-forge synchronization
75+
├── .machine_readable/ # 6a2 metadata, contractiles, bot directives
76+
├── aletheia/ # Microkernel implementation (Rust)
77+
├── tests/ # E2E, property, aspect tests
78+
├── GOVERNANCE.adoc # Project governance
79+
├── README.adoc # This file
80+
├── EXPLAINME.adoc # Receipts backing README claims
81+
├── ROADMAP.adoc # Development phases
82+
└── SECURITY.md # Vulnerability reporting policy
83+
84+
## Infrastructure
85+
86+
- **Hub-and-spoke mirroring** to GitLab, Codeberg, Bitbucket
87+
88+
- **SHA-pinned GitHub Actions** for supply chain security
89+
90+
- **SSH host key verification** for MITM protection
91+
92+
- **Minimal permission model** (`contents:` `read`)
93+
94+
# Language Policy
95+
96+
This project follows the **Hyperpolymath Standard** for technology
97+
choices.
98+
99+
| Technology | Use Case |
100+
|---------------------|-------------------------------------|
101+
| AffineScript | Primary application code |
102+
| Deno | Runtime & package management |
103+
| Rust | Performance-critical, systems, WASM |
104+
| Tauri 2.0+ / Dioxus | Mobile applications |
105+
| Gleam | Backend services (BEAM/JS) |
106+
| Guile Scheme | State/meta files |
107+
108+
Allowed
109+
110+
See <a href=".claude/CLAUDE.md" class="md">CLAUDE</a> for complete
111+
policy.
112+
113+
# Mirrors
114+
115+
GitHub
116+
[hyperpolymath/maa-framework](https://github.com/hyperpolymath/maa-framework)
117+
**(canonical)**
118+
119+
GitLab
120+
Synchronized automatically
121+
122+
Codeberg
123+
Synchronized automatically
124+
125+
Bitbucket
126+
Synchronized automatically
127+
128+
# Security
129+
130+
See <a href="SECURITY.md" class="md">SECURITY</a> for:
131+
132+
- Vulnerability reporting procedures
133+
134+
- Security measures implemented
135+
136+
- Secret management practices
137+
138+
# License
139+
140+
This project is licensed under the Mozilla Public License, v. 2.0. See
141+
the `LICENSE` file for details.
142+
143+
SPDX-License-Identifier: CC-BY-SA-4.0
144+
145+
# Contributing
146+
147+
Contribution guidelines will be established as the project develops.
148+
Currently maintained by
149+
[@hyperpolymath](https://github.com/hyperpolymath).

0 commit comments

Comments
 (0)