SkillsHooksPromptsAgentsPersonasModelsPoliciesToolsTemplatesBundlesCategoriesStart here
← Templates
Te templatereadmemarkdownknowledgestable

README

The README every repository must have, answering four questions in order: what is this, who is it for, how do I run it, how do I contribute or extend it. Short by design; detail lives in linked documents.

id template/readmev1.0.0placeholders 6

Skeleton

# {{project_name}}

**What is this?** {{what}}

**Who is it for?** {{audience}}

**How do I run it?**

```bash
{{run_commands}}
```

**How do I contribute or extend it?** {{contribute}}

{{license_line}}

Rendered example

# ai-atoms

**What is this?** A typed, versioned catalog of AI runtime primitives: skills, hooks, prompts, agents, personas, models, policies, tools, and templates.

**Who is it for?** Runtime authors that install behaviour by id, and contributors who publish it.

**How do I run it?**

```bash
pip install jsonschema pytest
python3 scripts/build-exports.py
python3 -m pytest
```

**How do I contribute or extend it?** See CONTRIBUTING.md for the per-class rules and docs/adr/ for why it is shaped this way.

Licensing: code Apache-2.0, data CC-BY-4.0.

Placeholders

NameRequiredWhat goes hereExample
{{project_name}}yesRepository or product name.ai-atoms
{{what}}yesOne or two sentences saying what the thing is and does.A typed, versioned catalog of AI runtime primitives.
{{audience}}yesWho should use it, by role.Runtime authors and contributors.
{{run_commands}}yesThe minimal commands that build, test, or start it from a clean machine.pip install jsonschema python3 scripts/build-exports.py
{{contribute}}yesWhere the contribution rules, spec, and architecture live.See CONTRIBUTING.md and docs/adr/.
{{license_line}}noLicense statement.Licensing: code Apache-2.0, data CC-BY-4.0.

Rules for the finished document

  • Answer the four questions in this order; do not add sections above them.
  • Commands must run on a clean machine; test them before committing.
  • Write at an 8th–10th grade reading level; link jargon on first use.

Produced by

readmedocsrequired-document
Author convergent-systems-key. Source ai-atoms. License CC-BY-4.0. Skeleton follows the README rule in the convergent-systems AI Constitution (required documents §4.9.1).