Skip to content
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.

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

Update readme to mention CI #3

Merged
merged 1 commit into from
Feb 10, 2024
Merged
Changes from all commits
Commits
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
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,8 @@ Checks can be run together with [`tox`](https://tox.wiki/).
To do so, install `tox` if it is not already installed. Make sure you have
version 4 or higher.

Then, at the top of this repository's working tree (the direcctory that
contains `tox.ini`), test and typecheck any of the individual packages as
follows:
Then, at the top of this repository's working tree (the directory that contains
`tox.ini`), test and typecheck any of the individual packages as follows:

```sh
tox --root by_literal
Expand All @@ -55,6 +54,10 @@ tox --root by_getattr
tox --root by_property
```

These `tox` checks also all
[run on CI](https://github.com/EliahKagan/version/actions/workflows/tox.yml).
See [`tox.yml`](.github/workflows/tox.yml).

## Further reading

- [Single-sourcing the package
Expand Down
Loading