docs: rewrite README for a public audience#29
Merged
Conversation
Lead with the thesis (EA as deterministic, validated code; AI supplies only judgment) and a verified quick-look demo before dev setup, add license/CI/python badges, and document install via 'pip install git+' (pipx/uvx) with a version-pin example. Wire 'ea pack fetch' into the install + quick-look flow: fetching the method library (packs + presets) into ~/.cache/ea resolves offline, so the quick-look no longer needs EA_PACK_PATH/EA_PRESET_PATH exports. Fix the demo preset id (startup-light was a test fixture -> lean-ux, a real production preset). examples/README: note read-only verbs resolve from materialized definitions/, with pack fetch for authoring.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Phase 1 of taking EAaC public — rewrite the README for a stranger, not a maintainer. Docs-only,
no design impact.
only judgment") and a verified quick-look demo before the dev instructions, which move to
the bottom. Adds license / CI / python badges and a contract diagram with P1/P2.
pip install git+…via pipx/uvx (no PyPI — decided out of scopefor now), with a
@v0.1.0version-pin example.ea pack fetchis wired into install + quick-look: fetching the method library (packs +presets) into
~/.cache/earesolves offline, so the quick-look no longer needsEA_PACK_PATH/EA_PRESET_PATHexports.startup-light, which is a test fixture, nota production preset → switched to
lean-ux.definitions/(need nothing), withea pack fetch .for authoring your own.Proof
Docs-only — no
src/change, so no new tests. Every command documented was run against thelive CLI and returns what the README claims:
ea pack fetch .→ok, fetches 6 packs + 3 presets into the cache;ea preset listthenresolves them offline with no path vars.
ea init→ea manifest adopt lean-ux→ea validate --all→ allstatus: ok.validate --all,type show,graph dependency,report coverageinexamples/retailco-enterprise/repo) → allokstandalone, no packs on path.examples/payments-oaa/repo:ea validate --all→ok(exit 0),ea manifest show→ok.No agent-facing behavior changed.
Notes
git+https://…install/clone/fetch commands and the@v0.1.0pin assume the repo ispublic (Phase 2) — intentional; they're the documented public-facing commands.