diff --git a/README.md b/README.md index ff98e26..4a91643 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,11 @@ This repository includes starter adapters to bootstrap interoperability: Ready to publish signal - Once all MVP components are validated and tests pass, a READY_TO_PUBLISH file will be created at the repo root to signal readiness for publishing. +Readiness & validation (local workflow) +- You can verify the end-to-end packaging and tests locally by running: + - `bash test.sh` (this runs pytest and packages the project via Python's build tooling) +- When the project is ready for publication in a registry, the repository should contain an empty file named `READY_TO_PUBLISH` at the root. This signals an explicit publish intent and should be committed as part of a release workflow. + MVP Roadmap (high level) - Phase 0 (0-2 weeks): define core protocol (Objects, Morphisms, Functors), publish contracts v0.2, implement two starter adapters, build a minimal ADMM-like solver and delta-sync engine. - Phase 1 (2-4 weeks): add a small set of global constraints (mesh energy balance, water budgets), governance ledger, offline simulations with digital twins.