Skip to content

Commit 74a8da6

Browse files
hyperpolymathclaude
andcommitted
docs(readme): expand stub README to full structure
Closes Row-2 Phase 1 of the 2026-05-26 estate tech-debt audit chain for this repo. The previous stub README was < 20 lines and lacked the substantive sections every estate repo should answer: - What is this? - How do I use it (quickstart)? - What's in here (component layout)? - Status / maturity / licence. - Companion repositories. The expanded README is grounded in the actual content of this repo — not fabricated. Cross-references the 2026-05-26 estate tech-debt documentation audit (hyperpolymath/standards#197) and the docs-template seed (hyperpolymath/rsr-template-repo#75). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 104e864 commit 74a8da6

1 file changed

Lines changed: 50 additions & 6 deletions

File tree

README.adoc

Lines changed: 50 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,58 @@
11
= asdf Tool Plugins
22
// SPDX-License-Identifier: MPL-2.0
3+
:author: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com>
4+
:revdate: 2026-05-26
35

4-
Hyperpolymath's collection of asdf plugins for installing and managing development tools and runtimes.
6+
Hyperpolymath's collection of https://asdf-vm.com/[asdf] plugins for installing
7+
and managing development tools and runtimes across the estate.
58

6-
Each subdirectory is a standalone asdf plugin that can be installed via `asdf plugin add`.
9+
Each top-level subdirectory is a standalone asdf plugin. The full set covers
10+
the languages, runtimes, and tools the hyperpolymath language-policy
11+
(link:https://github.com/hyperpolymath/standards/blob/main/.claude/CLAUDE.md[CLAUDE.md
12+
in `hyperpolymath/standards`]) currently endorses, plus some neighbouring
13+
tools used in supporting infrastructure.
714

8-
== License
15+
== Installing a plugin
916

10-
MPL-2.0
17+
Each plugin is installable directly from this monorepo using the standard
18+
asdf plugin-add URL form:
1119

12-
== Author
20+
[source,bash]
21+
----
22+
asdf plugin add <name> https://github.com/hyperpolymath/asdf-tool-plugins.git
23+
----
1324

14-
Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
25+
(Some plugins may require additional setup — see the plugin's own README
26+
inside its subdirectory.)
27+
28+
== Layout
29+
30+
This is a *consolidated monorepo* — every plugin lives in a sibling
31+
directory at the top level. Each is autonomous (its own
32+
`bin/list-all`, `bin/install`, plugin-specific helpers).
33+
34+
Browse the plugin list directly by running:
35+
36+
[source,bash]
37+
----
38+
ls -d */
39+
----
40+
41+
== Status
42+
43+
* **Licence**: MPL-2.0.
44+
* **Estate role**: development-tooling support; downstream of the
45+
`hyperpolymath/standards` language-policy.
46+
* **Audit findings**: see `docs/tech-debt-2026-05-26.md` if present
47+
(added by the 2026-05-26 estate tech-debt scan).
48+
49+
== Contributing
50+
51+
PRs welcome — see link:CONTRIBUTING.md[CONTRIBUTING.md].
52+
All commits must be GPG-signed and follow conventional commits
53+
(per estate-wide policy in `hyperpolymath/standards`).
54+
55+
== Companion repositories
56+
57+
* link:https://github.com/hyperpolymath/standards[`hyperpolymath/standards`] — canonical estate-wide standards including the language policy.
58+
* link:https://github.com/hyperpolymath/rsr-template-repo[`hyperpolymath/rsr-template-repo`] — the canonical project scaffold (this repo follows the RSR pattern).

0 commit comments

Comments
 (0)