From bd9870fcfadb64fc720c306444484a36a39fa7d0 Mon Sep 17 00:00:00 2001
From: Riegel <alexander.riegel@hft-stuttgart.de>
Date: Thu, 23 Jan 2025 09:30:08 +0100
Subject: [PATCH] Docs: Update README.md

---
 README.md | 38 ++++++++++++++++++++++++++++++--------
 1 file changed, 30 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 80695f8..703d18a 100644
--- a/README.md
+++ b/README.md
@@ -4,19 +4,38 @@
 
 CityDoctor2 is a Java program for validating CityGML files. It checks whether certain criteria for e.g. geometries are met and outputs a report on the results.
 
+CityDoctor2 supports version 3.0 of CityGML, with backwards compatibility for versions 2.0 and 1.0.
+
+CityDoctor2 requires Java version 17 or higher.
+
 ## Homepage
 
-[Here](https://transfer.hft-stuttgart.de/pages/citydoctor/citydoctorhomepage/de/) is a homepage with more detailed installation instruction and more information about the quality management process itself.
+The [CityDoctor homepage](https://transfer.hft-stuttgart.de/pages/citydoctor/citydoctorhomepage/de/) contains detailed
+installation instruction, as well as more information about the quality management process itself.
 
 ## Releases
 
-The newest releases can be found in this [gitlab repository](https://transfer.hft-stuttgart.de/gitlab/citydoctor/citydoctorreleases).
+The latest release of CityDoctor2 can be found under
+the [Releases](https://transfer.hft-stuttgart.de/gitlab/citydoctor/citydoctor2/-/releases) tab.
+
+Prebuilt binaries of the latest releases of the validation library (CityDoctorValidation-x.x.x) and the graphical user
+interface (CityDoctorGUI-x.x.x) can be found in
+this [gitlab repository](https://transfer.hft-stuttgart.de/gitlab/citydoctor/citydoctorreleases).
+
+CityDoctor2 uses [Semantic Versioning](https://semver.org/).
 
-You can download older releases from the BHT page [here](https://projekt.bht-berlin.de/citydoctor2/downloads/) or from a git repository [here](https://gitlab.com/volkercoors/CiD4Sim/-/tree/master/CityDoctorExtension).
+### Older releases
 
-Since version 3.12.0 CityDoctor2 requires java version 17, older version are based on version 1.8. The GUI version requires Javafx which is included in Java 1.8 but not in Java 17. You can download a Java version with Javafx included from [here](https://bell-sw.com/pages/downloads/#/java-17-lts). Choose your platform and then choose to download the full JRE or JDK which includes Javafx.
+Older versions of CityDoctor2, back to version 3.14.0, can also be found under Releases.
 
-The releases include builds for the validation library (CityDoctorValidation-x.x.x) and the grahpic user interface (CityDoctorGUI-x.x.x). While the GUI is not open source it is free to use.
+Versions older than 3.14.0 can be downloaded from the BHT
+page [here](https://projekt.bht-berlin.de/citydoctor2/downloads/) or from a git
+repository [here](https://gitlab.com/volkercoors/CiD4Sim/-/tree/master/CityDoctorExtension).
+
+Versions older than 3.15.0 require a JDK/JRE with the JavaFx library.   
+You can download a Java version with Javafx included from [here](https://bell-sw.com/pages/downloads/#/java-17-lts).
+
+Versions older than 3.12.0 require Java version 8 or higher.
 
 ## Build
 
@@ -39,10 +58,13 @@ There is a start script included in the binary releases of citydoctor. An exampl
 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
 ```
 
-Note:
--xmlReport, -pdfReport and -out are optional
+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
 
-## Extension
+## Extension modules
 
 Example extensions for CityDoctor are included in this repository, and can be found in the [Extensions subdirectory](./CityDoctorParent/Extensions)
 alongside a short description for each respective extension.
-- 
GitLab