[client,server] Add doc about how to build and configure server and client

1 files changed, 46 insertions, 0 deletions

diff --git a/dozentenmodul/README.md b/dozentenmodul/README.md
new file mode 100644
index 00000000..81b1e9c9
--- /dev/null
+++ b/dozentenmodul/README.md
@@ -0,0 +1,46 @@
+# bwSuite - Administration Client for Virtual Machines and Events
+
+The bwSuite (bwLehrpool-Suite) is a [bwLehrpool](https://www.bwlehrpool.de) client application to create and administrate virtual machines for study and coursework. With the help of the bwSuite it is possible to download ready-to-use virtual machine templates, which you can adapt locally for your purposes. Then, the bwSuite is capable to upload these personalized virtual machines to the [bwLehrpool-Server](../dozentenmodulserver/README.md), create new events and link the virtual machines to created events. Additionally, permissions can be set to grant selected or all users access to virtual machines.
+
+
+## Build
+A build of the bwSuite 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).
+
+### Dependencies
+If a Maven offline build takes place (`mvn -o`), the following dependencies are required and must be built manually first:
+
+  - [ecp-client-lean](https://git.openslx.org/bwlp/ecp-client-lean.git)
+  - [master-sync-shared](https://git.openslx.org/bwlp/master-sync-shared.git)
+  - [proxy-vole](https://git.openslx.org/bwlp/proxy-vole.git)
+
+### Application
+The bwSuite application can be built automatically by calling Maven with the following command line call:
+
+```shell
+mvn clean package
+```
+
+A build of the bwSuite application creates a Java archive file (\*.jar) that can be found at `target/dozmod-client-*-jar-with-dependencies.jar`.
+
+
+## Configuration
+
+### Logging
+The logging of the bwSuite application to the console is implemented with [log4j](https://logging.apache.org/log4j).
+
+#### Default Logging Configurations
+The default logging configurations are specified in the property file under `src/main/properties/log4j.properties`. This configuration file is packaged automatically into the bwSuite application during a build.
+
+#### Overwrite Logging Defaults
+If logging configurations other than the defaults are required, the configuration file packaged into the bwSuite application can be overwritten by specifiying a custom configuration file. The custom configuration file is specified by execute the bwSuite application with the following command line call where `<CONFIG>` is an absolute path to the custom configuration file and `<APP>` is a path to the built bwSuite application (Java archive file):
+
+```shell
+java -Dlog4j.configuration=file:<CONFIG> -jar <APP>
+```
+
+## Execution
+The bwSuite application can be executed with the following command line call where `<APP>` is a path to the built bwSuite application (Java archive file):
+
+```shell
+java -jar <APP>
+```