#
Installation and run
#
Requirements
- Windows
- Python (recommended: use
.venv)
#
Run the app
- Create and activate a virtual environment.
- Install project dependencies.
- Run
main.py.
Example (PowerShell):
python -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -r requiremensts
python main.py
#
Documentation (Retype)
Node.js (LTS) and npm are required.
Install Retype:
cd docs-site
npm install retypeapp --save-dev
Local preview:
cd docs-site
npx retype watch
Build a static site:
cd docs-site
npx retype build
Retype config is in docs-site/retype.yml. By default, sources are in docs-site/docs/ and output is docs-site/site/.