generated from coulomb/repo-seed
E2e tests and frist use docs
This commit is contained in:
11
README.md
11
README.md
@@ -15,6 +15,10 @@ requirements documents in `wiki/`.
|
||||
- `wiki/FunctionalRequirementsSpecification.md` - observable functional behavior
|
||||
- `docs/markitect-main-scope-assessment.md` - migration assessment from `markitect-main`
|
||||
- `docs/practical-usecase-relevance.md` - practical adoption usecases and relevance expectations
|
||||
- `docs/getting-started.md` - first-use guide from checkout to practical commands
|
||||
- `docs/command-cheatsheet.md` - command-oriented workflow cheat sheet
|
||||
- `docs/examples-index.md` - map from examples to usecases and commands
|
||||
- `docs/performance-notes.md` - local performance posture and smoke coverage
|
||||
- `docs/cli-reference.md` - generated `mkt` command reference
|
||||
- `docs/api-reference.md` - generated public API reference
|
||||
- `workplans/` - source-of-truth implementation and migration plans
|
||||
@@ -32,6 +36,13 @@ Run the tests:
|
||||
python3 -m pytest
|
||||
```
|
||||
|
||||
Install locally from a checkout:
|
||||
|
||||
```bash
|
||||
python3 -m pip install -e .
|
||||
mkt --help
|
||||
```
|
||||
|
||||
Try the parser CLI from a checkout:
|
||||
|
||||
```bash
|
||||
|
||||
Reference in New Issue
Block a user