Skip to content

Commit e6a58b9

Browse files
committed
docs(readme): keep quickstart runnable
The quickstart now uses uv-managed module execution so the README works from a fresh checkout without requiring manual virtualenv activation. This keeps the documented path aligned with the project's src layout and setup flow. Constraint: Quickstart steps should work without requiring manual venv activation Rejected: Add a separate venv activation step | more shell-specific and easier to skip Confidence: high Scope-risk: narrow Reversibility: clean Directive: Keep README command examples aligned with the uv-managed workflow unless setup semantics change Tested: uv run python -m python_template --help; uv run python -m python_template hello; python -m python_template --help (fails as expected without uv run) Not-tested: Full CI suite (docs-only change)
1 parent 95c7666 commit e6a58b9

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ cheap enough to run all the time.
1919
```bash
2020
make setup-dev
2121
make check
22-
python -m python_template --help
23-
python -m python_template hello
22+
uv run python -m python_template --help
23+
uv run python -m python_template hello
2424
```
2525

2626
Sample output:

0 commit comments

Comments
 (0)