From 9be1ce67be762198e63286fd9211f933d4616f5f Mon Sep 17 00:00:00 2001 From: Manuel Bentele Date: Tue, 25 May 2021 08:06:42 +0200 Subject: [client] Change deprecated name 'bwSuite' to 'bwLehrpool-Suite' in the documentation --- dozentenmodul/README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'dozentenmodul') diff --git a/dozentenmodul/README.md b/dozentenmodul/README.md index 9d78b394..12a61cb3 100644 --- a/dozentenmodul/README.md +++ b/dozentenmodul/README.md @@ -1,13 +1,13 @@ -# bwSuite - Administration Client for Virtual Machines and Events +# bwLehrpool-Suite - 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. +The 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 bwLehrpool-Suite it is possible to download ready-to-use virtual machine templates, which you can adapt locally for your purposes. +Then, the bwLehrpool-Suite 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). +A build of the bwLehrpool-Suite 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: @@ -17,34 +17,34 @@ If a Maven offline build takes place (`mvn -o`), the following dependencies are - [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: +The bwLehrpool-Suite 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`. +A build of the bwLehrpool-Suite 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). +The logging of the bwLehrpool-Suite 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. +This configuration file is packaged automatically into the bwLehrpool-Suite 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 `` is an absolute path to the custom configuration file and `` 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 bwLehrpool-Suite application can be overwritten by specifiying a custom configuration file. +The custom configuration file is specified by execute the bwLehrpool-Suite application with the following command line call where `` is an absolute path to the custom configuration file and `` is a path to the built bwLehrpool-Suite application (Java archive file): ```shell java -Dlog4j.configuration=file: -jar ``` ## Execution -The bwSuite application can be executed with the following command line call where `` is a path to the built bwSuite application (Java archive file): +The bwLehrpool-Suite application can be executed with the following command line call where `` is a path to the built bwLehrpool-Suite application (Java archive file): ```shell java -jar -- cgit v1.2.3-55-g7522