diff --git a/README.md b/README.md index 9206f25..2e67207 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,32 @@ Python3 website template including git actions -# Development -1. Install requirements +## Requirements +- UV + +## Development +1. Install project requirements ```bash -python3 -m pip install -r requirements.txt +uv sync ``` 2. Run the dev server ```bash -python3 server.py +uv run python3 server.py +``` +3. Alternatively use the virtual environment +```bash +source .venv/bin/activate +``` +You can exit the environment with `deactivate` + +For best development setup, you should install the git hook for pre-commit +```bash +uv run pre-commit install ``` -# Production + +## Production Run using the main.py file ```bash python3 main.py -``` \ No newline at end of file +```