From 59458d2a158c07b1e5d2ecab0be91c6de604b130 Mon Sep 17 00:00:00 2001
From: Manuel Bentele
Date: Fri, 21 May 2021 17:06:34 +0200
Subject: [client,server] Add doc about how to build and configure server and
 client

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..23eac65e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# bwSuite & bwLehrpool-Server
+
+The bwSuite (bwLehrpool-Suite) and the bwLehrpool-Server are two applications (client and server) that are part of [bwLehrpool](https://www.bwlehrpool.de). More information about both applications and their configurations can be found in the detailed description of the two application sub-projects:
+
+  - [bwSuite](dozentenmodul/README.md)
+  - [bwLehrpool-Server](dozentenmodulserver/README.md)
+
+
+## Build
+A build of both applications, namely the bwSuite and the bwLehrpool-Server, requires the installation of the build automation tool [Maven](https://maven.apache.org) and the Java development kit [OpenJDK 8](https://openjdk.java.net/projects/jdk8).
+
+Both applications can be built automatically by calling Maven with the following command line call:
+
+```shell
+mvn clean package
+```
+
+A build of both applications creates Java archive files (\*.jar) that are placed into each sub-project's `target` directory.
-- 
cgit v1.2.3-55-g7522