From d97d5a15fa96212e23e19f788fe01cf1c139fe55 Mon Sep 17 00:00:00 2001
From: "N. Geisler" <ngeisler@fachschaft.informatik.tu-darmstadt.de>
Date: Thu, 10 Oct 2019 17:47:07 +0200
Subject: [PATCH] add structure documentation

document project and (future) app structure in top-level README
---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index 52ae2f3d..21a8214f 100644
--- a/README.md
+++ b/README.md
@@ -63,3 +63,10 @@ In your browser, access ``http://127.0.0.1:8000/`` and continue from there.
 To update the setup to the current version on the main branch of the repository use the update script ``Utils/update.sh`` or ``Utils/update.sh --prod`` in production.
 
 Afterwards, you may check your setup by executing ``Utils/check.sh`` or ``Utils/check.sh --prod`` in production.
+
+
+## Structure
+
+This repository contains a Django project called AKPlanning. The functionality is encapsulated into Django apps:
+
+1. AKModel: This app contains the general Django models used to represent events, users, rooms, scheduling constraints etc. This app is a basic requirements for the other apps.
-- 
GitLab