// SPDX-License-Identifier: CC-BY-SA-4.0
// QUICKSTART-USER.adoc — consuming the standards in your own repo
= standards — Quick Start for Consumers
:toc:
:toclevels: 2

[NOTE]
This is a *specs* monorepo, not an application to install and run. "Using" it
means *applying* the standards to your own repository. The canonical front door
is link:README.adoc[README.adoc]; the machine index is
link:.machine_readable/REGISTRY.a2ml[REGISTRY.a2ml].

== What is standards?

The organization-wide source of truth for Hyperpolymath policies, the A2ML
metadata family, K9 components, the protocols, the readiness-grading
frameworks (ARG/FRG/CRG/TRG), RSR compliance, and the enforcement/CI that makes
them stick. See link:README.adoc[README.adoc] for the full overview and the
"if you want X, go here" routing table.

== Apply the standards to your repo

[source,bash]
----
git clone https://github.com/hyperpolymath/standards.git
----

. *Scaffold a compliant repo:* follow link:A2ML-REPO-TEMPLATE.adoc[A2ML-REPO-TEMPLATE.adoc]
  and the *Usage* section of link:README.adoc[README.adoc].
. *Add the 7 A2ML files:* copy from link:a2ml-templates/[`a2ml-templates/`] into
  your repo's `.machine_readable/`.
. *Adopt enforcement:* copy the relevant link:.github/workflows/[workflows] and
  link:hooks/[hooks] (language policy, doc-format, Makefile blocker, registry-verify).
. *Follow the language + licence policy:* link:.claude/CLAUDE.md[.claude/CLAUDE.md].

== Find a specific spec

Use the registry — it routes you from a spec `id` to its `home` and the one doc
to read first:

* Machine index: link:.machine_readable/REGISTRY.a2ml[`.machine_readable/REGISTRY.a2ml`]
* Prose + drift automation: link:REGISTRY.adoc[REGISTRY.adoc]

== Get help

* *Routing:* the table at the top of link:README.adoc[README.adoc]
* *Report a problem:* https://github.com/hyperpolymath/standards/issues
* *Architecture map (derived):* link:TOPOLOGY.md[TOPOLOGY.md]
