From 675198b753b152e7a431e072e85a5f625c0feb36 Mon Sep 17 00:00:00 2001 From: tegwick Date: Tue, 7 Jul 2026 01:34:42 +0200 Subject: [PATCH] Replace stale repo-seed template README with a real one Written from SCOPE.md/INTENT.md and direct source inspection. Requested during reuse-surface REUSE-WP-0017-T05 review follow-up. Co-Authored-By: Claude Sonnet 5 --- README.md | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fcd7b8f..7e8fc06 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,40 @@ -# repo-seed +# open-reuse -A git repository template to bootstrap coulomb projects from. \ No newline at end of file +*Managed continuity for valuable open-source integrations.* + +Pragmatically-created integrations with open-source software — a reused +component, an adapted service, an extracted module — become long-term +dependencies on upstream evolution once they prove valuable. `open-reuse` +turns those integrations into structured, maintainable, explicitly-owned +assets instead of letting them degrade into undocumented, silently-breaking +liabilities. The goal is not merely reuse, but **sustainable reuse under +change**. + +Every integration is analyzed, classified by reuse mode, given clear +boundaries and interfaces, and tracked with an explicit update loop against +its upstream. + +## Quick start + +```bash +open-reuse validate +open-reuse validate path/to/thing.integration.yaml --root . +``` + +`validate` checks integration definitions (`registry/integrations/*.integration.yaml`) +against `schemas/integration.schema.yaml` and the registry index +(`registry/indexes/integrations.yaml`). + +## Getting oriented + +- **Intent and problem statement:** `INTENT.md` +- **Scope and boundaries:** `SCOPE.md` +- **Product requirements:** `ProductRequirementsDocument.md` +- **Integration entry template:** `templates/integration-entry.template.yaml` +- **CLI source:** `open_reuse/cli.py`, `open_reuse/registry.py`, `open_reuse/validate.py` + +## In scope + +Integration analysis docs, registry, and workplans; reuse-mode +classification and continuity policies; State Hub progress and decisions. +See `SCOPE.md` for the full in/out-of-scope breakdown.