Skip to content

Commit 83f3415

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 6dbe1f7 commit 83f3415

2 files changed

Lines changed: 42 additions & 96 deletions

File tree

README.adoc

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

README.md

Lines changed: 42 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,64 @@
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
3+
SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
4+
-->
25

3-
= asdf Tool Plugins
4-
// SPDX-License-Identifier: CC-BY-SA-4.0
5-
:author: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com>
6-
:revdate: 2026-05-26
6+
Hyperpolymath’s collection of [asdf](https://asdf-vm.com/) plugins for
7+
installing and managing development tools and runtimes across the
8+
estate.
79

8-
Hyperpolymath's collection of https://asdf-vm.com/[asdf] plugins for installing
9-
and managing development tools and runtimes across the estate.
10+
Each top-level subdirectory is a standalone asdf plugin. The full set
11+
covers the languages, runtimes, and tools the hyperpolymath
12+
language-policy (<a
13+
href="https://github.com/hyperpolymath/standards/blob/main/.claude/CLAUDE.md"
14+
class="md
15+
in `hyperpolymath/standards`">CLAUDE</a>) currently endorses, plus some
16+
neighbouring tools used in supporting infrastructure.
1017

11-
Each top-level subdirectory is a standalone asdf plugin. The full set covers
12-
the languages, runtimes, and tools the hyperpolymath language-policy
13-
(link:https://github.com/hyperpolymath/standards/blob/main/.claude/CLAUDE.md[CLAUDE.md
14-
in `hyperpolymath/standards`]) currently endorses, plus some neighbouring
15-
tools used in supporting infrastructure.
18+
# Installing a plugin
1619

17-
== Installing a plugin
20+
Each plugin is installable directly from this monorepo using the
21+
standard asdf plugin-add URL form:
1822

19-
Each plugin is installable directly from this monorepo using the standard
20-
asdf plugin-add URL form:
21-
22-
[source,bash]
23-
----
23+
```bash
2424
asdf plugin add <name> https://github.com/hyperpolymath/asdf-tool-plugins.git
25-
----
25+
```
2626

27-
(Some plugins may require additional setup — see the plugin's own README
27+
(Some plugins may require additional setup — see the plugins own README
2828
inside its subdirectory.)
2929

30-
== Layout
30+
# Layout
3131

32-
This is a *consolidated monorepo* — every plugin lives in a sibling
33-
directory at the top level. Each is autonomous (its own
34-
`bin/list-all`, `bin/install`, plugin-specific helpers).
32+
This is a **consolidated monorepo** — every plugin lives in a sibling
33+
directory at the top level. Each is autonomous (its own `bin/list-all`,
34+
`bin/install`, plugin-specific helpers).
3535

3636
Browse the plugin list directly by running:
3737

38-
[source,bash]
39-
----
38+
```bash
4039
ls -d */
41-
----
40+
```
41+
42+
# Status
4243

43-
== Status
44+
- **Licence**: MPL-2.0.
4445

45-
* **Licence**: MPL-2.0.
46-
* **Estate role**: development-tooling support; downstream of the
46+
- **Estate role**: development-tooling support; downstream of the
4747
`hyperpolymath/standards` language-policy.
48-
* **Audit findings**: see `docs/tech-debt-2026-05-26.md` if present
48+
49+
- **Audit findings**: see `docs/tech-debt-2026-05-26.md` if present
4950
(added by the 2026-05-26 estate tech-debt scan).
5051

51-
== Contributing
52+
# Contributing
53+
54+
PRs welcome — see <a href="CONTRIBUTING.md" class="md">CONTRIBUTING</a>.
55+
All commits must be GPG-signed and follow conventional commits (per
56+
estate-wide policy in `hyperpolymath/standards`).
5257

53-
PRs welcome — see link:CONTRIBUTING.md[CONTRIBUTING.md].
54-
All commits must be GPG-signed and follow conventional commits
55-
(per estate-wide policy in `hyperpolymath/standards`).
58+
# Companion repositories
5659

57-
== Companion repositories
60+
- [`hyperpolymath/standards`](https://github.com/hyperpolymath/standards)
61+
— canonical estate-wide standards including the language policy.
5862

59-
* link:https://github.com/hyperpolymath/standards[`hyperpolymath/standards`] — canonical estate-wide standards including the language policy.
60-
* link:https://github.com/hyperpolymath/rsr-template-repo[`hyperpolymath/rsr-template-repo`] — the canonical project scaffold (this repo follows the RSR pattern).
63+
- [`hyperpolymath/rsr-template-repo`](https://github.com/hyperpolymath/rsr-template-repo)
64+
— the canonical project scaffold (this repo follows the RSR pattern).

0 commit comments

Comments
 (0)