From 7ba987f370cb18c9fe4e95022245a9d263e351a8 Mon Sep 17 00:00:00 2001
From: Matthias Betz <matthias.betz@hft-stuttgart.de>
Date: Tue, 17 May 2022 14:48:04 +0200
Subject: [PATCH] improved readme

---
 README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 53 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ba34ed7..ff81ce6 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # CityGMLViewer
 
-A CityGMLViewer based on OpenGL. Can display CityGML 2 and 3
+A CityGMLViewer based on OpenGL. Can display CityGML 2 and 3. Uses LWJGL for displaying and JOGL for tesselation.
 
 ## Installation
 
@@ -9,3 +9,55 @@ Use [Maven](https://maven.apache.org/) to build the viewer.
 ```bash
 mvn package
 ```
+
+## Usage
+
+
+```bash
+java -jar citygml-viewer-lwjgl-{version}.jar [-debug] [-colors <path-to-color-properties>] [-mapping <path-to-mapping-file>] [<path-to-citygml-file]
+```
+
+if you don't want the command prompt visible use javaw instead of java.
+
+#### Return codes:
+
+| Code | Meaning |
+| ---- | ------- |
+| 0    | OK      |
+| 1    | the color properties file is either not a file or does not exist |
+| 2    | the polygon color mapping file is either not a file or does not exist |
+| 3    | the citygml file that is supposed to be displayed is either not a file or does not exist |
+
+#### Color Mapping (-colors)
+
+You can change the default color of the polygons depending on their type in a color.properties file. The color notation in this file is a floating point value from 0 to 1 for each color channel rgb.
+
+Example:
+```properties
+groundColor=0.9411765 0.9019608 0.54901963
+roofColor=1 0 0
+doorColor=1 0.784313 0
+windowColor=0.0 0.5019608 0.5019608
+wallColor=1 1 1
+bridgeColor=1 0.49803922 0.3137255
+landColor=0.64705884 0.16470589 0.16470589
+transportationColor=1 1 0
+vegetationColor=0.5647059 0.93333334 0.5647059
+waterColor=0.5294118 0.80784315 0.98039216
+```
+
+#### Polygon Color Mapping (-mapping)
+
+You can specify the color of a specific polygon via its gml:id and a color. The color here is for each rgb channel a value between 0 and 255
+
+Example that would color a polygon in blue:
+```
+# polygonName, red (0 - 255), green (0 - 255), blue (0 - 255)
+PolyIDGeo22796924,0,0,255
+```
+
+## Known Problems
+
+* The color is not set correctly when the geometry of a surface is in the solid and the boundary surface is only referencing it.
+* The two configuration file use different color formats
+* Missing launch scripts
-- 
GitLab