Skip to content

fix: Update readme with install change for uv, dev group included by default #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wevonosky wants to merge 2 commits into from
Closed

fix: Update readme with install change for uv, dev group included by default #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
268b30f
Update readme with install change for uv, dev group included by default
wevonosky Feb 4, 2026
64e16d7
Update checklist with uv sync command
wevonosky Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ Install the project in editable mode with development dependencies:
# with pip
pip install -e ".[dev]"

# with uv
uv sync --extra dev
# with uv (dev included by default)
uv sync

# with poetry
poetry install --extras dev
Expand Down
2 changes: 1 addition & 1 deletion docs/CHECKLIST.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ install your project using the package manager of your choice:

- [ ] **USER:** Install dependencies using **pip**, **uv**, or **poetry**:
- `pip install -e ".[dev]"`.
- `uv sync --extra dev`.
- `uv sync`.
- `poetry install --extras dev`.
- [ ] **USER:** Run `prek install`.
- [ ] **USER:** Run the application `python -m <package_name>.main`.
Expand Down