Skip to content

docs(readme): add Install + License, restructure feature sections#1

Merged
neuron7xLab merged 1 commit into
mainfrom
docs/readme-install-license
Jun 25, 2026
Merged

docs(readme): add Install + License, restructure feature sections#1
neuron7xLab merged 1 commit into
mainfrom
docs/readme-install-license

Conversation

@neuron7xLab

Copy link
Copy Markdown
Owner

What

README was a version-stamped append-log with no onboarding path or license.

  • Install — Python 3.10+, stdlib-only, pip install -e ., cmar doctor.
  • Quickstart heading over the existing core pipeline.
  • De-versioned feature headers (## X v1.4.1## X); command bodies unchanged.
  • License — MIT stanza.

CMAR-STATS auto-refresh block untouched (markers preserved).

🤖 Generated with Claude Code

The README read as a version-stamped changelog with no onboarding path.
- add Install (Python 3.10+, stdlib-only, `pip install -e .`, `cmar doctor`)
- wrap the core pipeline under a Quickstart heading
- drop "vX.Y.Z" suffixes from feature headers (changelog noise in a README);
  command bodies unchanged
- add MIT License stanza
CMAR-STATS auto-block left untouched.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@neuron7xLab neuron7xLab merged commit 64f2723 into main Jun 25, 2026
6 checks passed
@neuron7xLab neuron7xLab deleted the docs/readme-install-license branch June 25, 2026 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant