Skip to content

Commit 7523fbb

Browse files
docs(readme): convert README.adoc -> Markdown (renders on Glama/profile/community-health) (#35)
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 f556c75 commit 7523fbb

2 files changed

Lines changed: 130 additions & 119 deletions

File tree

README.adoc

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

README.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
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+
[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github)](https://github.com/sponsors/hyperpolymath)
7+
8+
# What Is This?
9+
10+
Anvomidaviser converts **ISU (International Skating Union) notation**
11+
into formal figure skating programs via **Anvomidav** — the first
12+
programming language for figure skating choreography.
13+
14+
The pipeline: ISU notation → formal choreography models → scoring
15+
validation → program component analysis.
16+
17+
Anvomidaviser bridges existing notation systems (ISU element codes, IJS
18+
protocols, Code of Points tables) to formally verified Anvomidav
19+
programs.
20+
21+
# How It Works
22+
23+
Describe your program in `anvomidaviser.toml` or import ISU protocols.
24+
Anvomidaviser:
25+
26+
1. **Parses** ISU element codes — jumps (`3Lz`, `4T+3T`), spins
27+
(`CCoSp4`), steps (`StSq3`), lifts
28+
29+
2. **Validates** against ISU technical rules — Zayak rule, element
30+
counts, well-balanced requirements
31+
32+
3. **Scores** using the Code of Points — base values, GOE adjustments,
33+
PCS, deductions
34+
35+
4. **Generates** formal Anvomidav programs with timing, transitions,
36+
and rink positions
37+
38+
5. **Outputs** score sheets, validation reports, and choreography files
39+
40+
# Use Cases
41+
42+
- **Competition program planning** — build programs, check legality,
43+
estimate scores before training
44+
45+
- **Judging consistency checks** — verify scores against ISU rules
46+
programmatically
47+
48+
- **Training feedback** — track element difficulty progression across
49+
seasons
50+
51+
- **Coaching tools** — visualise program layout, timing, and transitions
52+
53+
# Architecture
54+
55+
Follows the hyperpolymath -iser pattern:
56+
57+
anvomidaviser.toml (manifest)
58+
|
59+
v
60+
ISU Parser (Rust CLI)
61+
|
62+
v
63+
Idris2 ABI (proves scoring rule correctness)
64+
|
65+
v
66+
Zig FFI (C-ABI bridge to scoring engine)
67+
|
68+
v
69+
Anvomidav Codegen (formal program descriptions)
70+
71+
Part of the [-iser family](https://github.com/hyperpolymath/iseriser).
72+
73+
# CLI Commands
74+
75+
```bash
76+
# Create a new manifest
77+
anvomidaviser init
78+
79+
# Validate a manifest against ISU rules
80+
anvomidaviser validate -m anvomidaviser.toml
81+
82+
# Generate Anvomidav program and score sheets
83+
anvomidaviser generate -m anvomidaviser.toml -o generated/
84+
85+
# Build generated artifacts
86+
anvomidaviser build -m anvomidaviser.toml --release
87+
88+
# Run the scoring engine
89+
anvomidaviser run -m anvomidaviser.toml
90+
91+
# Show manifest information
92+
anvomidaviser info -m anvomidaviser.toml
93+
```
94+
95+
# Example Manifest
96+
97+
```toml
98+
[workload]
99+
name = "ladies-short-2026"
100+
discipline = "ladies-single"
101+
segment = "short-program"
102+
103+
[elements]
104+
jump_1 = "3Lz+3T"
105+
spin_1 = "FCSp4"
106+
step_seq = "StSq4"
107+
jump_2 = "3F"
108+
spin_2 = "CCoSp4"
109+
jump_3 = "2A"
110+
spin_3 = "LSp4"
111+
112+
[program]
113+
music = "Clair de Lune"
114+
duration_seconds = 160
115+
116+
[output]
117+
format = "anvomidav"
118+
score_sheet = true
119+
validation_report = true
120+
```
121+
122+
# Status
123+
124+
**Pre-alpha / Codebase in progress.** Architecture defined, CLI
125+
scaffolded, bespoke Idris2 ABI types for ISU scoring, Zig FFI stubs with
126+
anvomidaviser symbols. Codegen and scoring engine pending.
127+
128+
# License
129+
130+
SPDX-License-Identifier: CC-BY-SA-4.0

0 commit comments

Comments
 (0)