Skip to content

Commit 00d2027

Browse files
revert(readme): restore canonical README.adoc (#43)
Restores canonical README.adoc and removes the README.md from the over-broad 'convert -> Markdown' pass. AsciiDoc is canonical; .md only on boj-server + hyperpolymath. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 0064da1 commit 00d2027

2 files changed

Lines changed: 149 additions & 152 deletions

File tree

README.adoc

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
// SPDX-License-Identifier: CC-BY-SA-4.0
2+
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
3+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[MPL-2.0-or-later,link="https://opensource.org/licenses/MPL-2.0"]
4+
= DocMatrix
5+
image:https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=openssourcesecurity[OpenSSF Best Practices,link="https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/docmatrix"]
6+
7+
8+
9+
10+
:toc: left
11+
:toclevels: 3
12+
:icons: font
13+
:source-highlighter: rouge
14+
15+
image:https://img.shields.io/badge/Philosophy-Palimpsest-indigo.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-license"]
16+
17+
== License & Philosophy
18+
19+
This project must declare **MPL-2.0-or-later** for platform/tooling compatibility.
20+
21+
Philosophy: **Palimpsest**. The MPL-2.0 (PMPL) text is provided in `license/MPL-2.0.txt`, and the canonical source is the palimpsest-license repository.
22+
23+
Cross-platform document editor with format tabs (TXT/MD/ADOC/DJOT/ORG/RST/TYP). Gossamer GUI + Ada TUI. Graph visualization, OCR, TTS/STT, Nickel pipelines.
24+
25+
== Features
26+
27+
* *Format Tabs* - View and edit the same document in multiple markup formats
28+
* *Unified AST* - Lossless conversion between formats
29+
* *GUI* - Gossamer with ReScript frontend
30+
* *TUI* - Ada with AdaCurses for terminal usage
31+
* *Graph Visualization* - ArangoDB for document relationships
32+
* *Accessibility* - OCR, TTS, STT support
33+
* *Pipelines* - Nickel-based import/export transformations
34+
35+
== Supported Formats
36+
37+
[cols="1,2", options="header"]
38+
|===
39+
| Format | Description
40+
41+
| TXT | Plain text
42+
| MD | Markdown (CommonMark)
43+
| ADOC | AsciiDoc
44+
| DJOT | Djot markup
45+
| ORG | Org-mode
46+
| RST | reStructuredText
47+
| TYP | Typst
48+
|===
49+
50+
== Quick Start
51+
52+
[source,bash]
53+
----
54+
# Check dependencies
55+
just deps
56+
57+
# Build all components
58+
just build
59+
60+
# Run GUI
61+
just run-gui
62+
63+
# Run TUI
64+
just run-tui
65+
----
66+
67+
== Architecture
68+
69+
[source]
70+
----
71+
crates/
72+
├── formatrix-core/ # AST, parsers, renderers
73+
├── formatrix-gui/ # Gossamer commands
74+
├── formatrix-db/ # ArangoDB client
75+
└── formatrix-pipeline/ # Nickel executor
76+
77+
tui/src/ # Ada TUI source
78+
ui/src/ # ReScript components
79+
pipelines/ # Nickel pipeline definitions
80+
container/ # Wolfi container configs
81+
----
82+
83+
== Development
84+
85+
=== Prerequisites
86+
87+
* Rust (stable)
88+
* Deno
89+
* GNAT + gprbuild (for TUI)
90+
* GTK4 + WebKit2GTK (for GUI)
91+
92+
=== Build Commands
93+
94+
[source,bash]
95+
----
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+
[source,bash]
108+
----
109+
just container-build # Build Wolfi image
110+
just compose-up # Start with ArangoDB
111+
just container-run-tui # Run TUI in container
112+
----
113+
114+
== RSR Compliance
115+
116+
This project follows the Rhodium Standard Repositories specification:
117+
118+
* *Tier 2* - Full-featured multi-language project
119+
* See link:RSR_COMPLIANCE.adoc[RSR_COMPLIANCE.adoc] for details
120+
121+
== Related Scripts
122+
123+
Automation scripts from https://github.com/hyperpolymath/scripts[hyperpolymath/scripts]:
124+
125+
[cols="1,2", options="header"]
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+
138+
These scripts follow the same language policy (Bash, Rust, ReScript, 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+
* link:.machine_readable/6a2/STATE.a2ml[Project State]
147+
* link:.machine_readable/6a2/ECOSYSTEM.a2ml[Ecosystem Position]
148+
* link:.machine_readable/6a2/META.a2ml[Architecture Decisions]
149+
* link:PALIMPSEST.adoc[Palimpsest Philosophy]

README.md

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

0 commit comments

Comments
 (0)