Merge branch 'dev_db_config' into 'dev'

Version 3.18.2

See merge request !39

DBSettings.properties

+! Embedded database configuration
+! Remove # at the beginning of a parameter line to override the value.
+
+! Directory for the database file. DEFAULT: \\database\\
+# database.directory=\\database\\
+! Name of the database file. DEFAULT: cd_db
+# database.name=cd_db
+
+! Sets a limit for the number of pooled connections to the embedded database. DEFAULT: 10
+! If not overridden CityDoctor will use the number of available CPU cores as limit.
+# database.connectionPoolSize=10
+
+! If temp mode is enabled the database-file will be created in the System's TEMP directory. DEFAULT: false
+# database.tempMode=false
+
+! If in-memory mode is enabled the database will be created in the Systems RAM. DEFAULT: false
+! WARNING: Enabling in-memory mode can lead to out-of-memory errors when loading bigger CityGML files.
+# database.inMemoryMode=false
+
+! If fallback is enabled CityDoctor will attempt to use the in-memory mode if database-file creation fails DEFAULT: true
+# database.attemptFallback=true
+
+! If debug mode is enabled the embedded database will start in automatic mixed mode DEFAULT: false
+! NOTE: Activating this mode will start a local server with random ports. This may trigger a Firewall request, which can be safely denied.
+! NOTE: This server is only accessible locally and automatically rejects any remote connections.
+# database.debugMode=false
+
+
+
+

README.md

@@ -43,7 +43,7 @@ Use [Maven](https://maven.apache.org/) to build CityDoctor2.
 
 ```bash
 cd CityDoctorParent
-mvn install
+mvn clean install -P create-binaries 
 ```
 
 CityDoctor2 uses the [quality ade plugin](https://transfer.hft-stuttgart.de/gitlab/betzms/qualityade). A jar is provided in a local repository for ease of use.
@@ -55,14 +55,16 @@ Once built there is a CityDoctorValidation-\<version\>.zip file in the target fo
 There is a start script included in the binary releases of citydoctor. An example start command looks like this:
 
 ```bash
-java -classpath libs/*;plugins/*;CityDoctorValidation-<version>.jar de.hft.stuttgart.citydoctor2.CityDoctorValidation -in <path-to-gml-file>.gml -config <path-to-validation-config>.yml -xmlReport <path-to-xml-output>.xml -pdfReport <path-to-pdf-output>.pdf -out <path-to-output-gml>.gml
+java -classpath libs/*;plugins/*;CityDoctorValidation-<version>.jar de.hft.stuttgart.citydoctor2.CityDoctorValidation -in <path-to-gml-file>.gml -config <path-to-validation-config>.yml -xmlReport <path-to-xml-output>.xml -pdfReport <path-to-pdf-output>.pdf -out <path-to-output-gml>.gml -db_location <path-for-database-file> -db_settings <path-to-database-settings-file>.properties
 ```
 
 Notes:
 
-- -xmlReport, -pdfReport and -out are optional
-- If a ZIP file is given as input, CityDoctor2 will check all contained CityGML files. The -out parameter is required in
-  this case
+- -xmlReport, -pdfReport, -out, -db_location and -db_settings are optional
+- Paths will be resolved from CityDoctor's working directory
+- See [DBSettings.properties](DBSettings.properties) for the formatting of the database-settings file
+- The -db_location parameter takes precedence over the location set in the database-settings file
+- The start scripts included in the binary releases have -db_location set to the system's temp directory
 
 ## Extension modules