From 30a61b7d0e87a9f62439d23ec8872d1d09e1bbbb Mon Sep 17 00:00:00 2001
From: Janis Steiner <89935073+jakani24@users.noreply.github.com>
Date: Thu, 27 Jun 2024 16:09:13 +0000
Subject: [PATCH] Update README.md
---
README.md | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/README.md b/README.md
index e48f19a..9aac83d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
# system0-test
This is the test repo for experimental system0 features. Currently it houses the new docker system that we are developing instead of the normal sys0-image.
+
+# system0
+Frontend system for octoprint
+This repo contains the code from system0 a frontend user controll system for octoprint
+The goal of system0 is to be a system that can controll multiple octoprint 3d printers at the same time.
+The system has to be able to register users (students) and must have the functionallity to upload files etc. for printing.
+Additionally it should be able to have something like a queue so even if no printer is "free" users can upload theyr files and the system will automaticly send it to a printer as soon as a printer is "free".
+
+
+System0 is mainly written for ksw (Kantonsschule Wattwil ST. Gallen CH-switzerland)
+
+
+# usability
+Due to the fact that this project will mainly be used at KSW it won't be to easy to set up.
+You will need to have root access on both the octoprint as well as the webserver.
+Additionally you will need to be able to install ngrok onto your octoprint server (NOT the plugin but the standalone app)
+As well as the mysql databases for user and printermanagement.
+
+# warning
+My code often looks horribly and uses outdated methods.
+So be prepared for ugly code.
+
+# User management
+System0 has its own user management with users and admins.
+But due to the modular design of system0 it should not be hard to add new usertypes or permissions.
+The user management of octoprint is not used. All the API calls go throu the admin api key of octoprint.