added some simple documentation
This commit is contained in:
parent
7d1ceded8d
commit
39a8d7c1db
25
README.md
25
README.md
@ -0,0 +1,25 @@
|
|||||||
|
# Installing
|
||||||
|
|
||||||
|
```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:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
python3 -m http.server 1312
|
||||||
|
```
|
||||||
|
|
||||||
|
Then visit `localhost:1312`
|
||||||
|
|
||||||
|
```
|
||||||
|
# build it normally
|
||||||
|
stsg
|
||||||
|
|
||||||
|
# start a hot reload server
|
||||||
|
stsg_dev
|
||||||
|
```
|
Loading…
x
Reference in New Issue
Block a user