From 399025f7adadab6f51b9ea96df82a19db1cd31f7 Mon Sep 17 00:00:00 2001
From: Jakob Yanagibashi <yanagibashi@kg.rwth-aachen.de>
Date: Tue, 2 May 2023 15:25:41 +0200
Subject: [PATCH] Add testing and production env URL to readme

---
 README    | 11 -----------
 README.md | 15 +++++++++++++++
 2 files changed, 15 insertions(+), 11 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index f3e2fe6..0000000
--- a/README
+++ /dev/null
@@ -1,11 +0,0 @@
-# Tailorbird
-
-Easy but powerful tool to aid with manual G-code creation for 3D printers. Including 6-axis robot arm support. Please note that this currently is not yet finished and actively being worked on.
-
-# Installation
-
-Just clone the repository and open the index.htm file in a web browser.
-
-# Dependencies
-
-Currently some dependencies are loaded automatically from CDN. We aim to change this before 1.0 release.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d1076a7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Tailorbird
+
+Easy but powerful tool to aid with manual G-code creation for 3D printers. Including 6-axis robot arm support. Please note that this currently is not yet finished and actively being worked on.
+
+## Testing Environment
+
+https://kg.pages.git-ce.rwth-aachen.de/tailorbird
+
+If you commit and push to `dev` branch, the CI will build from the newest commit belonging to that branch and upload the output to above GitLab Pages server. This should be considered public, but the URL is not advertised to students so there's no risk of breaking anybody's projects.
+
+## Production
+
+https://tailorbird3d.rwth-aachen.de/
+
+If you commit and push to `main` branch, the CI will build from the newest commit belonging to that branch and upload the output to FH Aachen administered web server with vanity URL from RWTH Aachen. This should be considered public.
\ No newline at end of file
-- 
GitLab