Skip to content

Commit 77ff0fe

Browse files
hyperpolymathclaude
andcommitted
docs(readme): convert README.adoc -> Markdown README.md
README must be real Markdown to render in GitHub community-health, the GitHub profile, and external MCP directories (Glama) — AsciiDoc shows as raw markup there. pandoc asciidoc->GFM, badges fixed to clickable, SPDX header kept as an HTML comment, duplicate README.adoc removed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent ba53b43 commit 77ff0fe

2 files changed

Lines changed: 152 additions & 149 deletions

File tree

README.adoc

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

README.md

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
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+
[![MPL-2](https://img.shields.io/badge/License-MPL_2.0-blue.svg)](https://opensource.org/licenses/MPL-2.0) = DocMatrix [![OpenSSF Best Practices](https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=openssourcesecurity)](https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/formatrix-docs)
7+
8+
[![Palimpsest](https://img.shields.io/badge/Philosophy-Palimpsest-indigo.svg)](https://github.com/hyperpolymath/palimpsest-license)
9+
10+
# License & Philosophy
11+
12+
This project must declare **MPL-2.0-or-later** for platform/tooling
13+
compatibility.
14+
15+
Philosophy: **Palimpsest**. The MPL-2.0 (PMPL) text is provided in
16+
`license/MPL-2.0.txt`, and the canonical source is the
17+
palimpsest-license repository.
18+
19+
Cross-platform document editor with format tabs
20+
(TXT/MD/ADOC/DJOT/ORG/RST/TYP). Gossamer GUI + Ada TUI. Graph
21+
visualization, OCR, TTS/STT, Nickel pipelines.
22+
23+
# Features
24+
25+
- **Format Tabs** - View and edit the same document in multiple markup
26+
formats
27+
28+
- **Unified AST** - Lossless conversion between formats
29+
30+
- **GUI** - Gossamer with ReScript frontend
31+
32+
- **TUI** - Ada with AdaCurses for terminal usage
33+
34+
- **Graph Visualization** - ArangoDB for document relationships
35+
36+
- **Accessibility** - OCR, TTS, STT support
37+
38+
- **Pipelines** - Nickel-based import/export transformations
39+
40+
# Supported Formats
41+
42+
| Format | Description |
43+
|--------|-----------------------|
44+
| TXT | Plain text |
45+
| MD | Markdown (CommonMark) |
46+
| ADOC | AsciiDoc |
47+
| DJOT | Djot markup |
48+
| ORG | Org-mode |
49+
| RST | reStructuredText |
50+
| TYP | Typst |
51+
52+
# Quick Start
53+
54+
```bash
55+
# Check dependencies
56+
just deps
57+
58+
# Build all components
59+
just build
60+
61+
# Run GUI
62+
just run-gui
63+
64+
# Run TUI
65+
just run-tui
66+
```
67+
68+
# Architecture
69+
70+
crates/
71+
├── formatrix-core/ # AST, parsers, renderers
72+
├── formatrix-gui/ # Gossamer commands
73+
├── formatrix-db/ # ArangoDB client
74+
└── formatrix-pipeline/ # Nickel executor
75+
76+
tui/src/ # Ada TUI source
77+
ui/src/ # ReScript components
78+
pipelines/ # Nickel pipeline definitions
79+
container/ # Wolfi container configs
80+
81+
# Development
82+
83+
## Prerequisites
84+
85+
- Rust (stable)
86+
87+
- Deno
88+
89+
- GNAT + gprbuild (for TUI)
90+
91+
- Gossamer + WebKit2GTK (for GUI)
92+
93+
## Build Commands
94+
95+
```bash
96+
just build # Build all
97+
just build-core # Build Rust core only
98+
just build-tui # Build Ada TUI only
99+
just build-ui # Build ReScript UI only
100+
just test # Run all tests
101+
just fmt # Format all code
102+
just lint # Lint all code
103+
```
104+
105+
## Containers
106+
107+
```bash
108+
just container-build # Build Wolfi image
109+
just compose-up # Start with ArangoDB
110+
just container-run-tui # Run TUI in container
111+
```
112+
113+
# RSR Compliance
114+
115+
This project follows the Rhodium Standard Repositories specification:
116+
117+
- **Tier 2** - Full-featured multi-language project
118+
119+
- See <a href="RSR_COMPLIANCE.adoc" class="adoc">RSR_COMPLIANCE</a> for
120+
details
121+
122+
# Related Scripts
123+
124+
Automation scripts from
125+
[hyperpolymath/scripts](https://github.com/hyperpolymath/scripts):
126+
127+
| Script | Purpose |
128+
|----|----|
129+
| `asdfman.sh` | Manage asdf plugins and versions |
130+
| `init_bashrc_three_ply.sh` | Modular bashrc setup (three-layer architecture) |
131+
| `k-check.sh` | Kinoite cluster validation |
132+
| `k-intune.sh` | Kinoite tuning scripts |
133+
| `langstrap.sh` | Mass language install utilities |
134+
| `sysenv.sh` | System environment setup |
135+
| `touchscreen_hunter_killer.sh` | Touchscreen calibration/management |
136+
137+
These scripts follow the same language policy (Bash, Rust, ReScript,
138+
Deno, Gleam, Guile Scheme) and multi-forge mirroring strategy.
139+
140+
# License
141+
142+
MPL-2.0 with Palimpsest philosophy.
143+
144+
# Links
145+
146+
- [Project State](.machine_readable/6a2/STATE.a2ml)
147+
148+
- [Ecosystem Position](.machine_readable/6a2/ECOSYSTEM.a2ml)
149+
150+
- [Architecture Decisions](.machine_readable/6a2/META.a2ml)
151+
152+
- [Palimpsest Philosophy](PALIMPSEST.adoc)

0 commit comments

Comments
 (0)