added installation

This commit is contained in:
Hazel Noack
2025-05-16 17:21:19 +02:00
parent 6093e8df32
commit a01f94379d
6 changed files with 44 additions and 40 deletions

View File

@@ -2,26 +2,6 @@
This is the documentation for stsg.
## installation
```sh
python3 -m venv .venv
source .venv/bin/activate
pip install -e .
```
## execute
To start a local http server in the dist folder you can simply do:
```
python3 -m http.server 1312
```
Then visit `localhost:1312`
You can either build it normally with `stsg` or start a hot reload server with `stsg_dev`.
## build favicon
This is just a helpfull script to build the favicon. It is not strictly required to use. Make sure inkscape and imagemagick is installed.