HexCasting/doc/README.md
2023-06-27 10:01:18 -04:00

23 lines
368 B
Markdown

# doc
Contains the Python docgen for Hex Casting.
## Setup
The minimum Python version to run this script is `3.11`.
```sh
cd doc
python -m venv venv
.\venv\Scripts\activate # Windows
source venv/bin/activate # anything other than Windows
pip install -r requirements-dev.txt
```
## Usage
```sh
python -m hexcasting.scripts.main properties.toml -o out.html
```