From 39a8d7c1db9e6a9f7f4aeb2028cf66d8b5d3ca26 Mon Sep 17 00:00:00 2001
From: Hazel Noack <hazel@webcontact.de>
Date: Fri, 16 May 2025 14:09:29 +0200
Subject: [PATCH] added some simple documentation

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index e69de29..0fd5676 100644
--- a/README.md
+++ b/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
+```