diff --git a/README.adoc b/README.adoc deleted file mode 100644 index e39a83e..0000000 --- a/README.adoc +++ /dev/null @@ -1,84 +0,0 @@ -// SPDX-License-Identifier: CC-BY-SA-4.0 OR MPL-2.0 -// SPDX-FileCopyrightText: 2024-2025 hyperpolymath - -= Anvomidav - -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"] - -**The first programming language for choreographers of figure skating.** - -== Status - -[IMPORTANT] -==== -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. -==== - -== Vision - -Anvomidav aims to provide figure skating choreographers with a domain-specific language (DSL) to: - -* **Notate** — Precisely describe skating elements, transitions, and sequences -* **Compose** — Build complex programs from reusable choreographic patterns -* **Validate** — Check technical compliance with ISU (International Skating Union) rules -* **Visualize** — Generate rink diagrams, timing charts, and 3D previews -* **Collaborate** — Share and version-control choreographic works - -== Name - -_Anvomidav_ — etymology and meaning to be documented. - -== Technology Stack - -Per the link:.claude/CLAUDE.md[Hyperpolymath Standard]: - -[cols="1,2"] -|=== -| Component | Technology - -| Compiler/Interpreter -| OCaml or Rust - -| Runtime -| Deno (if JS target) or native - -| Editor Integration -| LSP server (Rust) - -| Visualization -| ReScript + WebGL/Canvas - -| Mobile Apps -| Tauri 2.0+ or Dioxus -|=== - -== Getting Started - -[source,bash] ----- -# Clone the repository -git clone https://github.com/hyperpolymath/anvomidav.git -cd anvomidav - -# Development environment (once implemented) -nix develop # Nix users -# or -guix shell # Guix users ----- - -== Documentation - -* link:ROADMAP.adoc[Roadmap] — Development phases and milestones -* link:CONTRIBUTING.md[Contributing] — How to participate -* link:SECURITY.md[Security Policy] — Vulnerability reporting -* link:CODE_OF_CONDUCT.md[Code of Conduct] — Community standards - -== License - -Dual-licensed under link:LICENSE.txt[MIT OR MPL-2.0]. Choose the license that best fits your use case. - -== Contributing - -Contributions welcome! This project is in early stages — input on language design, figure skating domain expertise, and implementation help are all valuable. - -See link:CONTRIBUTING.md[CONTRIBUTING.md] for guidelines. diff --git a/README.md b/README.md index 55f83da..5d7161d 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,57 @@ -[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github)](https://github.com/sponsors/hyperpolymath) + -// SPDX-License-Identifier: CC-BY-SA-4.0 OR MPL-2.0 -// SPDX-FileCopyrightText: 2024-2025 hyperpolymath - -= Anvomidav - -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"] +[![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) **The first programming language for choreographers of figure skating.** -== Status - -[IMPORTANT] -==== -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. -==== +# Status -== Vision +> [!IMPORTANT] +> This project is in the **concept phase**. The repository contains +> project infrastructure and governance documents, but no implementation +> yet. See ROADMAP for planned +> development. -Anvomidav aims to provide figure skating choreographers with a domain-specific language (DSL) to: +# Vision -* **Notate** — Precisely describe skating elements, transitions, and sequences -* **Compose** — Build complex programs from reusable choreographic patterns -* **Validate** — Check technical compliance with ISU (International Skating Union) rules -* **Visualize** — Generate rink diagrams, timing charts, and 3D previews -* **Collaborate** — Share and version-control choreographic works +Anvomidav aims to provide figure skating choreographers with a +domain-specific language (DSL) to: -== Name +- **Notate** — Precisely describe skating elements, transitions, and + sequences -_Anvomidav_ — etymology and meaning to be documented. +- **Compose** — Build complex programs from reusable choreographic + patterns -== Technology Stack +- **Validate** — Check technical compliance with ISU (International + Skating Union) rules -Per the link:.claude/CLAUDE.md[Hyperpolymath Standard]: +- **Visualize** — Generate rink diagrams, timing charts, and 3D previews -[cols="1,2"] -|=== -| Component | Technology +- **Collaborate** — Share and version-control choreographic works -| Compiler/Interpreter -| OCaml or Rust +# Name -| Runtime -| Deno (if JS target) or native +*Anvomidav* — etymology and meaning to be documented. -| Editor Integration -| LSP server (Rust) +# Technology Stack -| Visualization -| ReScript + WebGL/Canvas +Per the [Hyperpolymath Standard](.claude/CLAUDE.md): -| Mobile Apps -| Tauri 2.0+ or Dioxus -|=== +| Component | Technology | +|----------------------|-------------------------------| +| Compiler/Interpreter | OCaml or Rust | +| Runtime | Deno (if JS target) or native | +| Editor Integration | LSP server (Rust) | +| Visualization | ReScript + WebGL/Canvas | +| Mobile Apps | Tauri 2.0+ or Dioxus | -== Getting Started +# Getting Started -[source,bash] ----- +```bash # Clone the repository git clone https://github.com/hyperpolymath/anvomidav.git cd anvomidav @@ -66,21 +60,28 @@ cd anvomidav nix develop # Nix users # or guix shell # Guix users ----- +``` + +# Documentation + +- [Roadmap](ROADMAP.adoc) — Development phases and milestones + +- [Contributing](CONTRIBUTING.md) — How to participate -== Documentation +- [Security Policy](SECURITY.md) — Vulnerability reporting -* link:ROADMAP.adoc[Roadmap] — Development phases and milestones -* link:CONTRIBUTING.md[Contributing] — How to participate -* link:SECURITY.md[Security Policy] — Vulnerability reporting -* link:CODE_OF_CONDUCT.md[Code of Conduct] — Community standards +- [Code of Conduct](CODE_OF_CONDUCT.md) — Community standards -== License +# License -Dual-licensed under link:LICENSE.txt[MIT OR MPL-2.0]. Choose the license that best fits your use case. +Dual-licensed under [MIT OR MPL-2.0](LICENSE.txt). Choose the license +that best fits your use case. -== Contributing +# Contributing -Contributions welcome! This project is in early stages — input on language design, figure skating domain expertise, and implementation help are all valuable. +Contributions welcome! This project is in early stages — input on +language design, figure skating domain expertise, and implementation +help are all valuable. -See link:CONTRIBUTING.md[CONTRIBUTING.md] for guidelines. +See CONTRIBUTING for +guidelines.