pim/pg-rad
1
0
Fork 0
mirror of https://github.com/pim-n/pg-rad synced 2026-02-02 14:33:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'dev' of github.com:pim-n/pg-rad into dev

Browse Source
This commit is contained in:
Pim Nelissen
2026-01-28 13:50:35 +01:00
parent caec70b39b 21ea25a3d8
commit 2551f854d6
1 changed files with 18 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -23,13 +23,27 @@ With Python verion `>=3.12.4` and `<3.13`, create a virtual environment and inst
``` ```
python3 -m venv .venv python3 -m venv .venv
source .venv/bin/activate source .venv/bin/activate
(venv) pip install -e .[dev] ```
With the virtual environment activated, run:
```
pip install -e .[dev]
``` ```
## Tests ## Tests
Tests can be run with `pytest` from the root directory of the repository. Tests can be run with `pytest` from the root directory of the repository. With the virtual environment activated, run:
``` ```
(venv) pytest pytest
``` ```
## Local viewing of documentation
PG-RAD uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) for generating documentation. It can be locally viewed by (in the venv) running:
```
mkdocs serve
```
where you can add the `--livereload` flag to automatically update the documentation as you write to the Markdown files.