From 3ad2ae930a4dfd4f034059f82291fcf6d4fa0785 Mon Sep 17 00:00:00 2001
From: 0xf8 <0xf8.dev@proton.me>
Date: Sat, 25 Feb 2023 12:24:58 -0500
Subject: [PATCH] Add README.md

Signed-off-by: 0xf8 <0xf8.dev@proton.me>
---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..38a286b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Galerie
+
+## build
+Builds and correctly places everything.
+- `./build`
+
+## run
+Runs the standalone web and api server in the correct context.
+- `./run`
+
+## dev
+Runs development builds of the webserver (`http://localhost:1234`) and apiserver (`http://localhost:8856`)
+- `./dev`
+
+
+## /srv/
+This contains the standalone web server and api server
+- Warning! Don't build this by itself. It wont have a frontend nor static assets. Use the `build` script.
+
+## /web/
+This contains the front end and static assets
+- Warning! Don't build this by itself. It wont have the backend and wont be able to display any images in the gallery. Use the `build` script.
\ No newline at end of file