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 @@
Dies ist die Dokumentation von STSG. Dies ist die Dokumentation von STSG.
## Installation
```sh
python3 -m venv .venv
source .venv/bin/activate
pip install -e .
```
## Programm ausführen
Um einen lokalen http server zu starten kann folgender Befehl ausgeführt werden:
```
python3 -m http.server 1312
```
Dann ist die Seite auf `localhost:1312` zu finden
Man kann die Seite entweder normal bauen mit `stsg` oder mit `stsg_dev` einen hot reload server starten.
## Favicon bauen ## Favicon bauen
Dies ist einfach nur ein hilfreiches Skript um favicons zu erstellen. Dies ist nicht unbedingt notwendig. Aber bei verwendung muss inkscape und imagemagick installiert sein. Dies ist einfach nur ein hilfreiches Skript um favicons zu erstellen. Dies ist nicht unbedingt notwendig. Aber bei verwendung muss inkscape und imagemagick installiert sein.

View File

@ -2,26 +2,6 @@
This is the documentation for stsg. 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 ## 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. This is just a helpfull script to build the favicon. It is not strictly required to use. Make sure inkscape and imagemagick is installed.

View File

@ -0,0 +1,3 @@
# Get Started
Hier wird gezeigt wie man seine eigene website erstellen kann.

View File

@ -0,0 +1,3 @@
# get started
Here you will learn how to get started making your own website.

View File

@ -0,0 +1,19 @@
# Installation
```sh
python3 -m venv .venv
source .venv/bin/activate
pip install -e .
```
## Programm ausführen
Um einen lokalen http server zu starten kann folgender Befehl ausgeführt werden:
```
python3 -m http.server 1312
```
Dann ist die Seite auf `localhost:1312` zu finden
Man kann die Seite entweder normal bauen mit `stsg` oder mit `stsg_dev` einen hot reload server starten.

View File

@ -0,0 +1,19 @@
# 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`.