From e82d8415884f8078be56a8c299e41135b7db507c Mon Sep 17 00:00:00 2001
From: Hazel Noack <hazel@webcontact.de>
Date: Fri, 16 May 2025 17:02:39 +0200
Subject: [PATCH] feat: added documentation setup

---
 src/articles/documentation/en.md | 33 ++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/src/articles/documentation/en.md b/src/articles/documentation/en.md
index abcbccc..a6d4a21 100644
--- a/src/articles/documentation/en.md
+++ b/src/articles/documentation/en.md
@@ -1,3 +1,36 @@
 # documentation
 
 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.
+
+```
+cd src/static/assets
+inkscape -w 16 -h 16 -o 16.png logo.svg
+inkscape -w 32 -h 32 -o 32.png logo.svg
+inkscape -w 48 -h 48 -o 48.png logo.svg
+
+convert 16.png 32.png 48.png ../icon.ico
+```