Skip to content

Commit b5431f7

Browse files
docs(readme): convert README.adoc -> Markdown (renders on Glama/profile/community-health) (#41)
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 169c8c9 commit b5431f7

2 files changed

Lines changed: 92 additions & 238 deletions

File tree

README.adoc

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

README.md

Lines changed: 92 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,57 @@
1-
[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github)](https://github.com/sponsors/hyperpolymath)
2-
<!-- Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk> -->
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+
-->
35

4-
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"]
5-
// SPDX-License-Identifier: CC-BY-SA-4.0
6-
= DocMatrix
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/docmatrix)
77

8+
[![Palimpsest](https://img.shields.io/badge/Philosophy-Palimpsest-indigo.svg)](https://github.com/hyperpolymath/palimpsest-license)
89

10+
# License & Philosophy
911

10-
:toc: left
11-
:toclevels: 3
12-
:icons: font
13-
:source-highlighter: rouge
12+
This project must declare **MPL-2.0-or-later** for platform/tooling
13+
compatibility.
1414

15-
image:https://img.shields.io/badge/Philosophy-Palimpsest-indigo.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-license"]
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.
1618

17-
== License & Philosophy
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.
1822

19-
This project must declare **MPL-2.0-or-later** for platform/tooling compatibility.
23+
# Features
2024

21-
Philosophy: **Palimpsest**. The Palimpsest-MPL (PMPL) text is provided in `license/PMPL-1.0.txt`, and the canonical source is the palimpsest-license repository.
25+
- **Format Tabs** - View and edit the same document in multiple markup
26+
formats
2227

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.
28+
- **Unified AST** - Lossless conversion between formats
2429

25-
== Features
30+
- **GUI** - Gossamer with ReScript frontend
2631

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
32+
- **TUI** - Ada with AdaCurses for terminal usage
3433

35-
== Supported Formats
34+
- **Graph Visualization** - ArangoDB for document relationships
3635

37-
[cols="1,2", options="header"]
38-
|===
39-
| Format | Description
36+
- **Accessibility** - OCR, TTS, STT support
4037

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-
|===
38+
- **Pipelines** - Nickel-based import/export transformations
4939

50-
== Quick Start
40+
# Supported Formats
5141

52-
[source,bash]
53-
----
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
5455
# Check dependencies
5556
just deps
5657

@@ -62,88 +63,90 @@ just run-gui
6263

6364
# Run TUI
6465
just run-tui
65-
----
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
6675

67-
== Architecture
76+
tui/src/ # Ada TUI source
77+
ui/src/ # ReScript components
78+
pipelines/ # Nickel pipeline definitions
79+
container/ # Wolfi container configs
6880

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
81+
# Development
7682

77-
tui/src/ # Ada TUI source
78-
ui/src/ # ReScript components
79-
pipelines/ # Nickel pipeline definitions
80-
container/ # Wolfi container configs
81-
----
83+
## Prerequisites
8284

83-
== Development
85+
- Rust (stable)
8486

85-
=== Prerequisites
87+
- Deno
8688

87-
* Rust (stable)
88-
* Deno
89-
* GNAT + gprbuild (for TUI)
90-
* GTK4 + WebKit2GTK (for GUI)
89+
- GNAT + gprbuild (for TUI)
9190

92-
=== Build Commands
91+
- GTK4 + WebKit2GTK (for GUI)
9392

94-
[source,bash]
95-
----
93+
## Build Commands
94+
95+
```bash
9696
just build # Build all
9797
just build-core # Build Rust core only
9898
just build-tui # Build Ada TUI only
9999
just build-ui # Build ReScript UI only
100100
just test # Run all tests
101101
just fmt # Format all code
102102
just lint # Lint all code
103-
----
103+
```
104104

105-
=== Containers
105+
## Containers
106106

107-
[source,bash]
108-
----
107+
```bash
109108
just container-build # Build Wolfi image
110109
just compose-up # Start with ArangoDB
111110
just container-run-tui # Run TUI in container
112-
----
111+
```
113112

114-
== RSR Compliance
113+
# RSR Compliance
115114

116115
This project follows the Rhodium Standard Repositories specification:
117116

118-
* *Tier 2* - Full-featured multi-language project
119-
* See link:RSR_COMPLIANCE.adoc[RSR_COMPLIANCE.adoc] for details
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):
120126

121-
== Related Scripts
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 |
122136

123-
Automation scripts from https://github.com/hyperpolymath/scripts[hyperpolymath/scripts]:
137+
These scripts follow the same language policy (Bash, Rust, ReScript,
138+
Deno, Gleam, Guile Scheme) and multi-forge mirroring strategy.
124139

125-
[cols="1,2", options="header"]
126-
|===
127-
| Script | Purpose
140+
# License
128141

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-
|===
142+
MPL-2.0 with Palimpsest philosophy.
137143

138-
These scripts follow the same language policy (Bash, Rust, ReScript, Deno, Gleam, Guile Scheme) and multi-forge mirroring strategy.
144+
# Links
139145

140-
== License
146+
- [Project State](.machine_readable/6a2/STATE.a2ml)
141147

142-
PMPL-1.0 with Palimpsest philosophy.
148+
- [Ecosystem Position](.machine_readable/6a2/ECOSYSTEM.a2ml)
143149

144-
== Links
150+
- [Architecture Decisions](.machine_readable/6a2/META.a2ml)
145151

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]
152+
- [Palimpsest Philosophy](PALIMPSEST.adoc)

0 commit comments

Comments
 (0)