Set up project structure

alex-c · Feb 11, 2020 · c585e18 · c585e18
1 parent f7e3766
commit c585e18
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,13 @@
 # OpenMTS
-A material tracking system for the plastics industry.
+
+A material tracking system for the plastics industry. Built for the [Institute of Plastics Processing in Industry and the Skilled Crafts](https://www.ikv-aachen.de/) (IKV) during the author's Master's thesis.
+
+## Project Structure
+
+The [mts-backend](./mts-backend) directory contains the .NET Core backend service of OpenMTS.
+
+The [mts-frontend](./mts-frontend) directory contains the Vue.js frontend of OpenMTS.
+
+The [mts-iot-apps](./mts-iot-apps) directory contains IoT apps that use the OpenMTS backend API and have been built to simplify processes at the IKV.
+
+The [docs](./docs) directory contains the API documentation of the OpenMTS backend.
diff --git a/docs/.gitkeep b/docs/.gitkeep
diff --git a/mts-backend/.gitkeep b/mts-backend/.gitkeep
diff --git a/mts-frontend/.gitkeep b/mts-frontend/.gitkeep
diff --git a/mts-iot-apps/.gitkeep b/mts-iot-apps/.gitkeep