Skip to content

Commit

Permalink
add some comment on nox
Browse files Browse the repository at this point in the history
  • Loading branch information
leoschwarz committed Nov 7, 2024
1 parent 44ea73a commit 1769d1a
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,28 @@ uv pip install -e ".[dev]"
This creates the virtual environment in the `.venv` directory.
To activate the environment in your shell, you need to `source` the correct activation script from `.venv/bin`, e.g. `.venv/bin/activate` for bash.

### Install `nox`

To run the tests the same way as in the CI, you can use `nox`.
In general, you can use the latest version.
It's suggested to install it with `pipx` but any other way is fine too.

```bash
pipx install nox
```

Then you can run the checks with

```bash
nox
```

or more specifically:

```bash
nox -s tests
```

## Geometry Conventions

TODO these are not used consistently everywhere yet
Expand Down

0 comments on commit 1769d1a

Please sign in to comment.