@@ -15,17 +15,24 @@ decisions.
1515## Quick start
1616
1717FABLE5 requires Python 3.11 or newer and has no non-standard-library Python
18- runtime dependencies. For the checkout-based examples below, run commands from
19- the repository root. Install it in an isolated environment:
18+ runtime dependencies. Install the published prerelease in an isolated
19+ environment:
2020
2121``` sh
2222python3 -m venv .venv
2323. .venv/bin/activate
24- python -m pip install .
24+ python -m pip install fable5-assurance-toolkit==0.3.0rc5
2525assurance --version
2626assurance --help
2727```
2828
29+ For a source checkout, run commands from the repository root. To install the
30+ checkout for development instead of the published prerelease, use:
31+
32+ ``` sh
33+ python -m pip install .
34+ ```
35+
2936Run a deterministic governance-pack check against the included fixture:
3037
3138``` sh
@@ -239,10 +246,11 @@ contract, not recovery of historical source bytes, commits, or tags. The
239246reconstructed lineage; ` v0.3.0-recovery.2 ` records the subsequent public
240247open-source surface hardening; ` v0.3.0-recovery.3 ` generalizes the public
241248authorization contract for external maintainers; and ` v0.3.0-recovery.4 `
242- publishes the current contract hardening and consumer guidance. The prepared
243- ` v0.3.0-recovery.5 ` release adds first-run navigation, validated
249+ publishes the current contract hardening and consumer guidance. The published
250+ ` v0.3.0-recovery.5 ` prerelease adds first-run navigation, validated
244251maintainer-controlled workflow summaries, a runnable machine-consumer path,
245- and PEP 517 distribution metadata; it does not itself publish a package.
252+ and PEP 517 distribution metadata. Its Python distribution is available from
253+ PyPI as ` fable5-assurance-toolkit==0.3.0rc5 ` .
246254
247255The current status means the six modules and public interface have been
248256reconstructed and mechanically tested. Bounded independent review exists for
0 commit comments