unifold 0.1.0__tar.gz

unifold-0.1.0/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

unifold-0.1.0/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 The unifold authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

unifold-0.1.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: unifold
+Version: 0.1.0
+Summary: Check, draw and query the unifold architecture map of a repository
+License-Expression: MIT OR Apache-2.0
+Project-URL: Homepage, https://unifold.md
+Project-URL: Documentation, https://unifold.md/tool
+Keywords: architecture,documentation,monorepo,dependencies,agents
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE-MIT
+License-File: LICENSE-APACHE
+Requires-Dist: pyyaml>=6
+Dynamic: license-file
+
+# Unifold: architecture as code
+
+> All the knowledge for you, your team and your agents.
+
+**Your folder structure is your architecture.** A folder with a `unifold.yaml` is a unit: it declares what it provides and what it needs, next to the code, and the unit above connects every need to a provider. The unifold tool checks this map against the code and generates the diagrams, so nobody draws them and they cannot disagree with the files. Every unit keeps its documents in the same places, so that a person or a coding agent can understand one folder without reading its neighbours.
+
+## Why
+
+One large architecture document, one root file for agents and a wiki beside the code go stale, and neither a newcomer nor a coding agent can take them in. Here the knowledge about a folder is in that folder. Structure is declared once and generated, because it is cheap to derive and expensive to keep correct by hand. Reasons are written, because they cannot be derived, and because nobody should make the same mistake twice.
+
+The standard is explainable in one minute and adoptable in five. That is why the normative text is one page, and why everything else is reference, explanation or a tutorial that must not grow back into the standard.
+
+## How it works
+
+```yaml
+# billing/unifold.yaml
+summary: Creates invoices
+needs:
+  clock:
+    summary: A time source
+    contract: ../docs/references/clock.md
+```
+
+```yaml
+# platform/unifold.yaml
+summary: Shared runtime services
+capabilities:
+  clock:
+    summary: The current time
+    contract: ../docs/references/clock.md
+```
+
+```yaml
+# unifold.yaml in the repository root
+unifold: "0.1"
+name: shop
+summary: Shop backend
+wiring:
+  billing.clock: platform.clock
+```
+
+`billing` says what it needs, never who supplies it; the root connects the need to `platform`. Both sides name one document, `docs/references/clock.md` of the root: the contract of the connection, which says what a clock gives and in which form. `unifold check` reads the three manifests and the build files, and writes the component diagram. It fails on a need without a provider, on two sides that name different contracts, and on code that depends on a unit without a connection. If `billing` starts to use a unit `ledger` in its `Cargo.toml` without a need for it:
+
+```text
+error D1 unifold.yaml:4: 'billing' depends on 'ledger', but no need of 'billing' is connected to 'ledger' (cargo: billing/Cargo.toml [dependencies] ledger)
+    fix: Add a need to billing/unifold.yaml (for example `ledger`), and add `billing.ledger: ledger.journal` to the wiring here. Or remove the dependency from the code.
+```
+
+`unifold show billing` prints the unit, its need and who finally provides it. The tutorial [Your first map](docs/tutorials/first-map.md) takes fifteen minutes.
+
+## What a unit has
+
+| File | What it is |
+|---|---|
+| `unifold.yaml` | The manifest: what the unit provides and needs, and the wiring of its children. Checked against the other manifests and the code. |
+| `README.md` | The front page: what the unit is for, why it is built this way, what can be relied on. |
+| `docs/` | Everything else written about the unit, in fixed places sorted by what the reader is doing: tutorials, skills, references, explanation, decisions. A file exists only when it has content. |
+| `AGENTS.md` | Generated: where the documents and skills of the unit are, for coding agents. |
+
+## How people use it
+
+A newcomer opens a folder and reads its `README.md`. `docs/tutorials/` teaches, `docs/skills/` says how to do a task, `docs/references/` holds the facts, `docs/explanation/` the reasoning, the invariants, the runtime, the deployment and the risks, and `docs/decisions/` the choices. A reviewer runs `unifold check` and works through the [review checklist](docs/references/writing.md#review-checklist).
+
+## How agents use it
+
+`unifold init --agents` installs the two skills, writes their stubs into `.agents/skills/` and `.claude/skills/`, and adds the unifold block to the root `AGENTS.md`. Every unit's `AGENTS.md` is generated: a pointer to `README.md`, the documents by kind, the skills. Most agents read `AGENTS.md` and find the stubs; Kiro and Aider do not ([agents](docs/references/agents.md)). Every agent with a shell can run `unifold show`, which prints a folder's capabilities, needs and resolved neighbours, as text or JSON.
+
+## Questions
+
+**Do I need the tool?** Anyone can implement the standard, but its two promises, "checked" and "generated", need a checker. The reference tool is one Python file.
+
+**Do I need an AI agent?** No. The files are YAML and Markdown.
+
+**Does it read my code?** It reads build files and imports to find which unit depends on which, and compares that with the wiring, per pair of units. It does not judge whether a description is true.
+
+**Do I have to write documentation?** Every unit has a `README.md` that says what it is for and why. Everything else in `docs/` is written when there is something to say. The checker reads links, headings and length, never meaning.
+
+**Does it fit a project with one package?** Yes: a project of one unit. The map is one box; the documentation in fixed places is the point ([requirements](docs/explanation/requirements.md)).
+
+**What ends up in my repository?** The `unifold.yaml` files, the generated diagrams and the generated `AGENTS.md` of every unit. The standard is not copied; the root manifest names its version. With `--agents`, also the skills, the tool and the stubs.
+
+**What about my `docs/` folder, docs site and ADR tool?** `docs/` is where unifold keeps the documents, sorted by kind, and a site can be built from it. Existing decision records move to `docs/decisions/` ([documents](docs/references/documents.md)).
+
+**Is it stable?** No. This is draft 0.1, not yet published as a package. It has been tried on a handful of repositories and not measured in use ([risks](docs/explanation/risks.md)).
+
+## Capabilities
+
+What this repository provides. It is a specification, not a unit, so these are not declared in a manifest.
+
+### The standard
+
+The standard on one page, [spec.md](docs/references/spec.md), with the reference chapters beside it and a [JSON Schema](docs/references/unifold.schema.json) for the manifest. Published at [unifold.md](https://unifold.md).
+
+### The skills
+
+Two skills in the [Agent Skills](https://agentskills.io/specification) format. [unifold](docs/skills/unifold/SKILL.md), with file templates, teaches an agent to find its unit, read the right files, change manifests and documents, and check the result. [unifold-convert](docs/skills/unifold-convert/SKILL.md) brings an existing repository into the map: the agent chooses the units, writes their manifests and checks them against the code. No script derives units from code.
+
+### The tool
+
+The reference tool, described in [tool.md](docs/references/tool.md) and tested by [tests/conformance.py](tests/conformance.py). It checks manifests, compares the wiring with the dependencies in code, and generates the diagrams and the `AGENTS.md` files. A [GitHub Action](action.yml) and [pre-commit](https://pre-commit.com) hooks run it.
+
+## Needs
+
+### Python
+
+Python 3.9 or newer with PyYAML, for the tool and the tests. The standard itself needs nothing.
+
+## Commands
+
+```sh
+# test the tool
+python3 tests/conformance.py
+# check an example
+python3 docs/skills/unifold/scripts/unifold.py check examples/plantwatch
+# build the site and check its links
+python3 site/build.py --check
+```
+
+## Read next
+
+| Kind | Pages |
+|---|---|
+| The standard | [spec.md](docs/references/spec.md), the standard on one page; [unifold.schema.json](docs/references/unifold.schema.json) |
+| Reference | [documents](docs/references/documents.md), [writing](docs/references/writing.md), [agents](docs/references/agents.md), [tool](docs/references/tool.md), [tool JSON](docs/references/tool-json.md), [rules](docs/references/rules.md) |
+| Explanation | [requirements](docs/explanation/requirements.md), [reasoning](docs/explanation/reasoning.md), [wiring](docs/explanation/wiring.md), [invariants](docs/explanation/invariants.md), [risks](docs/explanation/risks.md), [decisions](docs/decisions/index.md) |
+| Tutorial | [Your first map](docs/tutorials/first-map.md) |
+| Examples | [slugline](examples/slugline/README.md), a tested Cargo workspace; [plantwatch](examples/plantwatch/README.md), a design written before any code, with every document convention |
+
+## Contributing and licence
+
+Changes to the standard are proposed as decision records; see [CONTRIBUTING.md](CONTRIBUTING.md) and the [decisions](docs/decisions/index.md).
+
+Licensed under either of the Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE)) or the MIT license ([LICENSE-MIT](LICENSE-MIT)), at your option. The templates of the skill and everything the tool generates may be used without attribution. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this work by you shall be dual licensed as above, without any additional terms or conditions.

unifold-0.1.0/README.md

@@ -0,0 +1,133 @@
+# Unifold: architecture as code
+
+> All the knowledge for you, your team and your agents.
+
+**Your folder structure is your architecture.** A folder with a `unifold.yaml` is a unit: it declares what it provides and what it needs, next to the code, and the unit above connects every need to a provider. The unifold tool checks this map against the code and generates the diagrams, so nobody draws them and they cannot disagree with the files. Every unit keeps its documents in the same places, so that a person or a coding agent can understand one folder without reading its neighbours.
+
+## Why
+
+One large architecture document, one root file for agents and a wiki beside the code go stale, and neither a newcomer nor a coding agent can take them in. Here the knowledge about a folder is in that folder. Structure is declared once and generated, because it is cheap to derive and expensive to keep correct by hand. Reasons are written, because they cannot be derived, and because nobody should make the same mistake twice.
+
+The standard is explainable in one minute and adoptable in five. That is why the normative text is one page, and why everything else is reference, explanation or a tutorial that must not grow back into the standard.
+
+## How it works
+
+```yaml
+# billing/unifold.yaml
+summary: Creates invoices
+needs:
+  clock:
+    summary: A time source
+    contract: ../docs/references/clock.md
+```
+
+```yaml
+# platform/unifold.yaml
+summary: Shared runtime services
+capabilities:
+  clock:
+    summary: The current time
+    contract: ../docs/references/clock.md
+```
+
+```yaml
+# unifold.yaml in the repository root
+unifold: "0.1"
+name: shop
+summary: Shop backend
+wiring:
+  billing.clock: platform.clock
+```
+
+`billing` says what it needs, never who supplies it; the root connects the need to `platform`. Both sides name one document, `docs/references/clock.md` of the root: the contract of the connection, which says what a clock gives and in which form. `unifold check` reads the three manifests and the build files, and writes the component diagram. It fails on a need without a provider, on two sides that name different contracts, and on code that depends on a unit without a connection. If `billing` starts to use a unit `ledger` in its `Cargo.toml` without a need for it:
+
+```text
+error D1 unifold.yaml:4: 'billing' depends on 'ledger', but no need of 'billing' is connected to 'ledger' (cargo: billing/Cargo.toml [dependencies] ledger)
+    fix: Add a need to billing/unifold.yaml (for example `ledger`), and add `billing.ledger: ledger.journal` to the wiring here. Or remove the dependency from the code.
+```
+
+`unifold show billing` prints the unit, its need and who finally provides it. The tutorial [Your first map](docs/tutorials/first-map.md) takes fifteen minutes.
+
+## What a unit has
+
+| File | What it is |
+|---|---|
+| `unifold.yaml` | The manifest: what the unit provides and needs, and the wiring of its children. Checked against the other manifests and the code. |
+| `README.md` | The front page: what the unit is for, why it is built this way, what can be relied on. |
+| `docs/` | Everything else written about the unit, in fixed places sorted by what the reader is doing: tutorials, skills, references, explanation, decisions. A file exists only when it has content. |
+| `AGENTS.md` | Generated: where the documents and skills of the unit are, for coding agents. |
+
+## How people use it
+
+A newcomer opens a folder and reads its `README.md`. `docs/tutorials/` teaches, `docs/skills/` says how to do a task, `docs/references/` holds the facts, `docs/explanation/` the reasoning, the invariants, the runtime, the deployment and the risks, and `docs/decisions/` the choices. A reviewer runs `unifold check` and works through the [review checklist](docs/references/writing.md#review-checklist).
+
+## How agents use it
+
+`unifold init --agents` installs the two skills, writes their stubs into `.agents/skills/` and `.claude/skills/`, and adds the unifold block to the root `AGENTS.md`. Every unit's `AGENTS.md` is generated: a pointer to `README.md`, the documents by kind, the skills. Most agents read `AGENTS.md` and find the stubs; Kiro and Aider do not ([agents](docs/references/agents.md)). Every agent with a shell can run `unifold show`, which prints a folder's capabilities, needs and resolved neighbours, as text or JSON.
+
+## Questions
+
+**Do I need the tool?** Anyone can implement the standard, but its two promises, "checked" and "generated", need a checker. The reference tool is one Python file.
+
+**Do I need an AI agent?** No. The files are YAML and Markdown.
+
+**Does it read my code?** It reads build files and imports to find which unit depends on which, and compares that with the wiring, per pair of units. It does not judge whether a description is true.
+
+**Do I have to write documentation?** Every unit has a `README.md` that says what it is for and why. Everything else in `docs/` is written when there is something to say. The checker reads links, headings and length, never meaning.
+
+**Does it fit a project with one package?** Yes: a project of one unit. The map is one box; the documentation in fixed places is the point ([requirements](docs/explanation/requirements.md)).
+
+**What ends up in my repository?** The `unifold.yaml` files, the generated diagrams and the generated `AGENTS.md` of every unit. The standard is not copied; the root manifest names its version. With `--agents`, also the skills, the tool and the stubs.
+
+**What about my `docs/` folder, docs site and ADR tool?** `docs/` is where unifold keeps the documents, sorted by kind, and a site can be built from it. Existing decision records move to `docs/decisions/` ([documents](docs/references/documents.md)).
+
+**Is it stable?** No. This is draft 0.1, not yet published as a package. It has been tried on a handful of repositories and not measured in use ([risks](docs/explanation/risks.md)).
+
+## Capabilities
+
+What this repository provides. It is a specification, not a unit, so these are not declared in a manifest.
+
+### The standard
+
+The standard on one page, [spec.md](docs/references/spec.md), with the reference chapters beside it and a [JSON Schema](docs/references/unifold.schema.json) for the manifest. Published at [unifold.md](https://unifold.md).
+
+### The skills
+
+Two skills in the [Agent Skills](https://agentskills.io/specification) format. [unifold](docs/skills/unifold/SKILL.md), with file templates, teaches an agent to find its unit, read the right files, change manifests and documents, and check the result. [unifold-convert](docs/skills/unifold-convert/SKILL.md) brings an existing repository into the map: the agent chooses the units, writes their manifests and checks them against the code. No script derives units from code.
+
+### The tool
+
+The reference tool, described in [tool.md](docs/references/tool.md) and tested by [tests/conformance.py](tests/conformance.py). It checks manifests, compares the wiring with the dependencies in code, and generates the diagrams and the `AGENTS.md` files. A [GitHub Action](action.yml) and [pre-commit](https://pre-commit.com) hooks run it.
+
+## Needs
+
+### Python
+
+Python 3.9 or newer with PyYAML, for the tool and the tests. The standard itself needs nothing.
+
+## Commands
+
+```sh
+# test the tool
+python3 tests/conformance.py
+# check an example
+python3 docs/skills/unifold/scripts/unifold.py check examples/plantwatch
+# build the site and check its links
+python3 site/build.py --check
+```
+
+## Read next
+
+| Kind | Pages |
+|---|---|
+| The standard | [spec.md](docs/references/spec.md), the standard on one page; [unifold.schema.json](docs/references/unifold.schema.json) |
+| Reference | [documents](docs/references/documents.md), [writing](docs/references/writing.md), [agents](docs/references/agents.md), [tool](docs/references/tool.md), [tool JSON](docs/references/tool-json.md), [rules](docs/references/rules.md) |
+| Explanation | [requirements](docs/explanation/requirements.md), [reasoning](docs/explanation/reasoning.md), [wiring](docs/explanation/wiring.md), [invariants](docs/explanation/invariants.md), [risks](docs/explanation/risks.md), [decisions](docs/decisions/index.md) |
+| Tutorial | [Your first map](docs/tutorials/first-map.md) |
+| Examples | [slugline](examples/slugline/README.md), a tested Cargo workspace; [plantwatch](examples/plantwatch/README.md), a design written before any code, with every document convention |
+
+## Contributing and licence
+
+Changes to the standard are proposed as decision records; see [CONTRIBUTING.md](CONTRIBUTING.md) and the [decisions](docs/decisions/index.md).
+
+Licensed under either of the Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE)) or the MIT license ([LICENSE-MIT](LICENSE-MIT)), at your option. The templates of the skill and everything the tool generates may be used without attribution. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this work by you shall be dual licensed as above, without any additional terms or conditions.