From e0751d6565d01c31ea47f6e84a845f2ff3d48e79 Mon Sep 17 00:00:00 2001 From: Ulrich <undisclosed> Date: Tue, 27 Feb 2018 15:35:26 +0000 Subject: [PATCH] Doku ergaenzt --- README.md | 23 +++++++++-------------- 1 files changed, 9 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 202dc24..9926698 100644 --- a/README.md +++ b/README.md @@ -22,39 +22,34 @@ Die Bedienoberfläche setzt auf eine für die Schnittstelle der radiozentrale angepasste Version des [radio-ui](/gitblit/docs/web!radio-ui.git) auf. -## Installation - -Hier noch die Installation beschreiben - -## Herstellung aus dem Quellcode - ## Webanwendung herstellen -Zum Herstellen der Webanwendung wird ein Java Development Kit (JDK) benötigt, wie es z.B. von [Azul](http://azul.com) oder dem [OpenJDK-Projekt](http://openjdk.java.net/) frei erhältlich ist. In der hier folgenden weiteren Beschreibung wird der lokale Ablageort des Java Development Kits `$JDK` genannt. +Zum Herstellen der Webanwendung wird ein Java Development Kit (JDK) benoetigt, wie es z.B. von [Azul](http://azul.com) oder dem [OpenJDK-Projekt](http://openjdk.java.net/) frei erhaeltlich ist. In der hier folgenden weiteren Beschreibung wird der lokale Ablageort des Java Development Kits `$JDK` genannt. -Desweiteren werden die folgenden Klassenbibliotheken benötigt +Desweiteren werden die folgenden Klassenbibliotheken benoetigt ``` Bibliothek Datei(en) Ablageort lokal ---------- --------- --------------- Tomcat .............. lib/servlet-api.jar ........... $CATALINA_HOME +derbyclient ......... lib/derbyclient.jar ........... $CATALINA_BASE XStream ............. xstream-1.4.7.jar ............. $JLIB Jettison ............ jettison-1.3.3.jar ............ $JLIB Transit ............. Transit.jar ................... $JLIB BaseLink ............ BaseLink.jar .................. $JLIB -derbyclient ......... derbyclient.jar ............... $JLIB ``` -Diese sind an folgenden Orten frei erhältlich: +Diese sind an folgenden Orten frei erhaeltlich: - [Apache Tomcat](http://tomcat.apache.org) +- [Apache Derby](http://db.apache.org/derby) - [XStream](https://github.com/codehaus/xstream) - [Jettison](https://github.com/codehaus/jettison) - [Transit](/gitblit/docs/Transit.git) - [BaseLink](/gitblit/docs/BaseLink.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=radiozentrale.git&h=master&format=zip) und entpackt. In der hier folgenden weiteren Beschreibung wird das so entstandene Verzeichnis `radiozentrale-master` einschließlich des absoluten Pfades dorthin `$RZ` 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. +Nach Beschaffung des JDK und der oben angegebenen Klassenbibliotheken wird der Quellcode aus diesem Git-Repository an einen frei waehlbaren lokalen Ablageort [heruntergeladen](http://uhilger.de/gitblit/zip/?r=radiozentrale.git&h=master&format=zip) und entpackt. In der hier folgenden weiteren Beschreibung wird das so entstandene Verzeichnis `radiozentrale-master` einschliesslich des absoluten Pfades dorthin `$RZ` genannt. Ferner wird angenommen, dass die oben aufgefuehrten 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. -Zur Herstellung der Dateiverwaltung werden die folgenden Kommandos ausgeführt (Beispiel für Linux): +Zur Herstellung der Dateiverwaltung werden die folgenden Kommandos ausgefuehrt (Beispiel fuer Linux): ``` cd $RZ @@ -74,7 +69,7 @@ rm -r build ``` -Das Webarchiv der Dateiverwaltung liegt anschließend als `$RZS/dist/rz.war` fertig zum Deployment bereit. +Das Webarchiv der Dateiverwaltung liegt anschliessend als `$RZS/dist/rz.war` fertig zum Deployment bereit. ### Distributionsalternative @@ -84,7 +79,7 @@ Die radiozentrale erfordert den Derby Client Datenbanktreiber (derbyclient.jar). Der Treiber ist nicht im Verteilpaket enthalten und sollte stattdessen im Ordner `$CATALINA_BASE/lib` von Tomcat hinterlegt sein. -## Abhängigkeiten +## Abhaengigkeiten Die Dateiverwaltung erfordert die folgenden Bestandteile auf der Instanz von Tomcat, auf der sie ausgeführt werden soll: (die nachfolgende Liste noch aktualisieren für das radio.ui) -- Gitblit v1.9.3