Skip to content

Update development workflow docs #22

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

Merged
DoctorJohn merged 1 commit into from
Oct 19, 2025
Merged

Update development workflow docs #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,7 @@ print(response)

## Development

1. Clone the repository and change into its directory
2. Create a virtual environment: `uv venv --seed`
3. Install dev dependencies: `uv sync --only-dev`
4. Activate the virtual environment: `source .venv/bin/activate`
5. Make changes to the code and tests
6. Build the package: `maturin develop`
7. Run the tests: `pytest`
1. Install dependencies into a virtual env: `uv sync`
2. Make changes to the code and tests
3. Build the package: `uv run maturin develop`
4. Run the tests: `uv run pytest`