Skip to content

Commit b8934c7

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 deed6e7 commit b8934c7

2 files changed

Lines changed: 53 additions & 136 deletions

File tree

README.adoc

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

README.md

Lines changed: 53 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,57 @@
1-
[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github)](https://github.com/sponsors/hyperpolymath)
1+
<!--
2+
SPDX-License-Identifier: CC-BY-SA-4.0 OR MPL-2.0
3+
SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
4+
-->
25

3-
// SPDX-License-Identifier: CC-BY-SA-4.0 OR MPL-2.0
4-
// SPDX-FileCopyrightText: 2024-2025 hyperpolymath
5-
6-
= Anvomidav
7-
8-
image:https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=opensourcesecurity[OpenSSF Best Practices, link="https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/anvomidav"]
6+
[![OpenSSF Best Practices](https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=opensourcesecurity)](https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/anvomidav)
97

108
**The first programming language for choreographers of figure skating.**
119

12-
== Status
13-
14-
[IMPORTANT]
15-
====
16-
This project is in the *concept phase*. The repository contains project infrastructure and governance documents, but no implementation yet. See link:ROADMAP.adoc[ROADMAP.adoc] for planned development.
17-
====
10+
# Status
1811

19-
== Vision
12+
> [!IMPORTANT]
13+
> This project is in the **concept phase**. The repository contains
14+
> project infrastructure and governance documents, but no implementation
15+
> yet. See <a href="ROADMAP.adoc" class="adoc">ROADMAP</a> for planned
16+
> development.
2017
21-
Anvomidav aims to provide figure skating choreographers with a domain-specific language (DSL) to:
18+
# Vision
2219

23-
* **Notate** — Precisely describe skating elements, transitions, and sequences
24-
* **Compose** — Build complex programs from reusable choreographic patterns
25-
* **Validate** — Check technical compliance with ISU (International Skating Union) rules
26-
* **Visualize** — Generate rink diagrams, timing charts, and 3D previews
27-
* **Collaborate** — Share and version-control choreographic works
20+
Anvomidav aims to provide figure skating choreographers with a
21+
domain-specific language (DSL) to:
2822

29-
== Name
23+
- **Notate** — Precisely describe skating elements, transitions, and
24+
sequences
3025

31-
_Anvomidav_ — etymology and meaning to be documented.
26+
- **Compose** — Build complex programs from reusable choreographic
27+
patterns
3228

33-
== Technology Stack
29+
- **Validate** — Check technical compliance with ISU (International
30+
Skating Union) rules
3431

35-
Per the link:.claude/CLAUDE.md[Hyperpolymath Standard]:
32+
- **Visualize** — Generate rink diagrams, timing charts, and 3D previews
3633

37-
[cols="1,2"]
38-
|===
39-
| Component | Technology
34+
- **Collaborate** — Share and version-control choreographic works
4035

41-
| Compiler/Interpreter
42-
| OCaml or Rust
36+
# Name
4337

44-
| Runtime
45-
| Deno (if JS target) or native
38+
*Anvomidav* — etymology and meaning to be documented.
4639

47-
| Editor Integration
48-
| LSP server (Rust)
40+
# Technology Stack
4941

50-
| Visualization
51-
| ReScript + WebGL/Canvas
42+
Per the [Hyperpolymath Standard](.claude/CLAUDE.md):
5243

53-
| Mobile Apps
54-
| Tauri 2.0+ or Dioxus
55-
|===
44+
| Component | Technology |
45+
|----------------------|-------------------------------|
46+
| Compiler/Interpreter | OCaml or Rust |
47+
| Runtime | Deno (if JS target) or native |
48+
| Editor Integration | LSP server (Rust) |
49+
| Visualization | ReScript + WebGL/Canvas |
50+
| Mobile Apps | Tauri 2.0+ or Dioxus |
5651

57-
== Getting Started
52+
# Getting Started
5853

59-
[source,bash]
60-
----
54+
```bash
6155
# Clone the repository
6256
git clone https://github.com/hyperpolymath/anvomidav.git
6357
cd anvomidav
@@ -66,21 +60,28 @@ cd anvomidav
6660
nix develop # Nix users
6761
# or
6862
guix shell # Guix users
69-
----
63+
```
64+
65+
# Documentation
66+
67+
- [Roadmap](ROADMAP.adoc) — Development phases and milestones
68+
69+
- [Contributing](CONTRIBUTING.md) — How to participate
7070

71-
== Documentation
71+
- [Security Policy](SECURITY.md) — Vulnerability reporting
7272

73-
* link:ROADMAP.adoc[Roadmap] — Development phases and milestones
74-
* link:CONTRIBUTING.md[Contributing] — How to participate
75-
* link:SECURITY.md[Security Policy] — Vulnerability reporting
76-
* link:CODE_OF_CONDUCT.md[Code of Conduct] — Community standards
73+
- [Code of Conduct](CODE_OF_CONDUCT.md) — Community standards
7774

78-
== License
75+
# License
7976

80-
Dual-licensed under link:LICENSE.txt[MIT OR MPL-2.0]. Choose the license that best fits your use case.
77+
Dual-licensed under [MIT OR MPL-2.0](LICENSE.txt). Choose the license
78+
that best fits your use case.
8179

82-
== Contributing
80+
# Contributing
8381

84-
Contributions welcome! This project is in early stages — input on language design, figure skating domain expertise, and implementation help are all valuable.
82+
Contributions welcome! This project is in early stages — input on
83+
language design, figure skating domain expertise, and implementation
84+
help are all valuable.
8585

86-
See link:CONTRIBUTING.md[CONTRIBUTING.md] for guidelines.
86+
See <a href="CONTRIBUTING.md" class="md">CONTRIBUTING</a> for
87+
guidelines.

0 commit comments

Comments
 (0)