Skip to content

Commit 97e577b

Browse files
Merge pull request #38 from Stephenson-Software/feature/readme-ci-trigger-accuracy
docs: correct the CI trigger description and state the supported Python range
2 parents 9b51186 + 49263f5 commit 97e577b

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,16 @@ Color constants: `Graphik.black`, `Graphik.white`, `Graphik.red`, `Graphik.green
4444
## Dependencies
4545
- pygame
4646

47+
Python 3.9 or newer is required (`requires-python` in [pyproject.toml](pyproject.toml)). The test suite is run against 3.9 through 3.13; see [`.github/workflows/test.yml`](.github/workflows/test.yml) for why 3.13 is the ceiling.
48+
4749
## Development
4850
```bash
4951
python -m venv .venv
5052
source .venv/bin/activate
5153
pip install -e ".[test]"
5254
pytest
5355
```
54-
The suite is headless: `src/test/python/conftest.py` sets `SDL_VIDEODRIVER`/`SDL_AUDIODRIVER` to `dummy` before pygame touches a display, so no window is created and the tests run on a machine with no display attached. `pytest` alone works from the repo root because `[tool.pytest.ini_options]` in `pyproject.toml` points `testpaths` at `src/test/python` and `pythonpath` at `src/main/python`. `.github/workflows/test.yml` runs the same `pip install -e ".[test]"` + `pytest` sequence on every push and pull request.
56+
The suite is headless: `src/test/python/conftest.py` sets `SDL_VIDEODRIVER`/`SDL_AUDIODRIVER` to `dummy` before pygame touches a display, so no window is created and the tests run on a machine with no display attached. `pytest` alone works from the repo root because `[tool.pytest.ini_options]` in `pyproject.toml` points `testpaths` at `src/test/python` and `pythonpath` at `src/main/python`. `.github/workflows/test.yml` runs the same `pip install -e ".[test]"` + `pytest` sequence — preceded by a compile check and an import smoke test, across the supported Python versions — on every pull request and on every push to `main`. A push to a branch with no open pull request is not covered, so run `pytest` locally before opening one.
5557

5658
## Projects
5759
[Projects that utilize this library](https://github.com/Stephenson-Software/graphik/wiki/Projects)

0 commit comments

Comments
 (0)