Readme angepasst

ulrich

2021-01-29 59dbdaf4808d3663303b9417e05861428f798ec0

 readme.md

@@ -37,7 +37,19 @@
- [BaseLink](https://uhilger.de/gitblit/docs/BaseLink.git)
- [Transit](https://uhilger.de/gitblit/docs/Transit.git)

Nach Beschaffung des JDK und der oben angegebenen Klassenbibliotheken wird der Quellcode aus diesem Git-Repository an einen frei wählbaren lokalen Ablageort [heruntergeladen](http://uhilger.de/gitblit/zip/?r=um.git&h=master&format=zip) und entpackt. In der hier folgenden weiteren Beschreibung wird das so entstandene Verzeichnis `um-master` einschließlich des absoluten Pfades dorthin `$UM` genannt. Ferner wird angenommen, dass die oben aufgeführten Klassenbibliotheken lokal an Orten abgelegt sind, deren Pfade mit den Platzhaltern `$JLIB` und `$CATALINA_HOME` gemeint sind. Anstelle der Platzhalter in den folgenden Kommandos muss also der absolute Pfad des lokalen Ablageortes eingesetzt werden.
Ferner erfordert die Nutzerverwaltung die folgenden Javascript-Bibliotheken und Schriftarten:

```
$JSLIB/mustache (>=2.3.0)
$FONTS/Roboto_Condensed/RobotoCondensed-Regular.ttf
```

Nachfolgend die Quellen, von denen Mustache und der Font bezogen werden können:

- [Mustache](https://github.com/janl/mustache.js)
- [Roboto Condensed](https://fonts.google.com/specimen/Roboto+Condensed)

Nach Beschaffung des JDK und der oben angegebenen Klassenbibliotheken wird der Quellcode aus diesem Git-Repository an einen frei wählbaren lokalen Ablageort [heruntergeladen](http://uhilger.de/gitblit/zip/?r=um.git&h=master&format=zip) und entpackt. In der hier folgenden weiteren Beschreibung wird das so entstandene Verzeichnis `um-master` einschließlich des absoluten Pfades dorthin `$UM` genannt. Ferner wird angenommen, dass die oben aufgeführten Bibliotheken und Schriftarten lokal an Orten abgelegt sind, deren Pfade mit den Platzhaltern `$JLIB`, `$JSLIB` und `$FONTS` gemeint sind. Anstelle der Platzhalter in den folgenden Kommandos muss also der absolute Pfad des lokalen Ablageortes eingesetzt werden.

Zur Herstellung der Nutzerverwaltung werden die folgenden Kommandos ausgeführt (Beispiel für Linux):

@@ -47,8 +59,13 @@
cp -r web/* build
cd build/WEB-INF
mkdir classes lib
cd ../..
cd ..
mkdir fonts
mkdir jslib
cd ..
cp $JLIB/* build/WEB-INF/lib
cp -r $JSLIB/* build/jslib
cp -r $FONTS/* build/fonts

$JDK/bin/javac -classpath $JLIB/jettison-1.3.3.jar:$JLIB/BaseLink.jar:$JLIB/Transit.jar:$JLIB/xstream-1.4.7.jar:$CATALINA_HOME/lib/servlet-api.jar -d ./build/WEB-INF/classes  src/java/de/uhilger/um/*.java src/java/de/uhilger/um/api/*.java src/java/de/uhilger/um/web/*.java src/java/de/uhilger/um/daten/*.java

@@ -61,20 +78,6 @@
### Distributionsalternative

Das Kommando `cp $JLIB/* build/WEB-INF/lib` kann auch weggelassen werden, dann sind die Klassenbibliotheken nicht Teil des Webarchivs der Nutzerverwaltung. In diesem Fall muss stattdessen der Inhalt von `$JLIB` nach `$CATALINA_BASE/lib` kopiert werden.

## Abhängigkeiten

Die Nutzerverwaltung erfordert zur Verarbeitung von HTML-Vorlagen Mustache auf der Instanz von Tomcat, auf der sie ausgeführt werden soll. Zudem wird der Font Roboto Condensed verwendet, der von Google Fonts erhältlich ist. Beide Teile werden im ROOT-Kontext von Tomcat wie folgt hinterlegt:

```
$CATALINA_BASE/webapps/ROOT/jslib/mustache (>=2.3.0)
$CATALINA_BASE/webapps/ROOT/fonts/Roboto_Condensed/RobotoCondensed-Regular.ttf
```

`$CATALINA_BASE` im obigen Beispiel meint das in der der Datei [RUNNING.txt](http://tomcat.apache.org/tomcat-8.5-doc/RUNNING.txt) der Tomcat-Dokumentation so bezeichnete Verzeichnis. Nachfolgend die Quellen, von denen Mustache und der Font bezogen werden können:

- [Mustache](https://github.com/janl/mustache.js)
- [Roboto Condensed](https://fonts.google.com/specimen/Roboto+Condensed)

### Datenbank