summaryrefslogtreecommitdiffstats
path: root/dozentenmodul/README.md
diff options
context:
space:
mode:
authorManuel Bentele2021-05-25 07:59:56 +0200
committerManuel Bentele2021-05-25 07:59:56 +0200
commit448efdb25558d1b53109a442db94ae6b3844d9a2 (patch)
tree1bdb760154dd6f2634142fdebdb2161355f09697 /dozentenmodul/README.md
parent[client,server] Add doc about how to build and configure server and client (diff)
downloadtutor-module-448efdb25558d1b53109a442db94ae6b3844d9a2.tar.gz
tutor-module-448efdb25558d1b53109a442db94ae6b3844d9a2.tar.xz
tutor-module-448efdb25558d1b53109a442db94ae6b3844d9a2.zip
[client,server] Add a newline after each sentence in the documentation
Diffstat (limited to 'dozentenmodul/README.md')
-rw-r--r--dozentenmodul/README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/dozentenmodul/README.md b/dozentenmodul/README.md
index 81b1e9c9..9d78b394 100644
--- a/dozentenmodul/README.md
+++ b/dozentenmodul/README.md
@@ -1,6 +1,9 @@
# 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.
+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
@@ -29,10 +32,12 @@ A build of the bwSuite application creates a Java archive file (\*.jar) that can
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.
+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):
+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>