From c259d990ad63b38140985ba6e25b5046dd767833 Mon Sep 17 00:00:00 2001 From: ulrich Date: Fri, 22 Nov 2024 08:16:48 +0000 Subject: [PATCH] Build-Anweisungen in Readme aktualisiert. --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++---- 1 files changed, 42 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0fd4433..a2b66bf 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,54 @@ Weitere Informationen auf der [Produktseite](https://uhilger.de/data/pg/tango/). +## Voraussetzungen + +Zur Herstellung von Tango aus dem Quellcode wird ein Java Development Kit (JDK) benötigt. Das JDK ist von [Adoptium](https://adoptium.net/) frei erhältlich. In der hier folgenden weiteren Beschreibung wird der lokale Ablageort des Java Development Kits `$JDK` genannt. + +## Quellcode von Tango erhalten + +Der Quellcode von Tango wird von hier an einen frei wählbaren lokalen Ablageort heruntergeladen und entpackt. In der hier folgenden weiteren Beschreibung wird das so entstandene Verzeichnis `tango` einschließlich des absoluten Pfades dorthin `$TANGO` genannt. Anstelle von `$TANGO` würde man also beispielweise `/home/fred/tango` notieren, wenn in das persönliche Verzeichnis des Benutzers `fred` heruntergealden und entpackt wurde. + ## Abhängigkeiten -Tango nutzt und erfordert die folgenden Produkte: +neon-fm erfordert die Klassenbibliotheken -[Java](https://adoptopenjdk.net/) - Ablaufumgebung +* [Gson](https://google.github.io/gson/) +* [neon](https://uhilger.de/gitblit/docs/web!neon.git) und +* [fm](https://uhilger.de/gitblit/docs/fm.git) + +## Abhängigkeiten + +Tango nutzt und erfordert die folgenden Klassenbibliotheken: + [Gson](https://github.com/google/gson) - JSON/Java Serialisierung und Deserialisierung [jID3Lib](http://javamusictag.sourceforge.net/) - Java ID3 Tag Library + +Die obigen Bestandteile müssen zur Herstellung von Tango an einen Ablageort auf der lokalen Maschine heruntergeladen werden. Zudem werden auf der Seite des Clients folgende Hilfsmittel eingesetzt: + [Mustache](http://mustache.github.io/) - "Logic-less templates." -[RobotoRegular](https://fonts.google.com/specimen/Roboto) - Schriftart +[Roboto](https://fonts.google.com/specimen/Roboto) - Schriftart + +Mustache und Roboto sind im Quellcode von Tango in den Ordnern `www/font` und `www/js/mustache` hinterlegt. + +## Tango herstellen + +Es wird angenommen, dass die als Abhängigkeiten aufgeführten Klassenbibliotheken lokal an einem Ort abgelegt sind, dessen Pfad mit dem Platzhalter `$JLIB` gemeint ist. Zur Herstellung von Tango werden mit Hilfe der wie zuvor beschrieben geladenen Teile die folgenden Kommandos ausgeführt (Beispiel für Linux): + +``` +cd $TANGO +mkdir classes +mkdir dist +$JDK/bin/javac -classpath $JLIB/gson-2.8.6.jar:$JLIB/jid3lib-0.5.4.jar -d classes src/de/uhilger/tango/*.java src/de/uhilger/tango/api/*.java src/de/uhilger/tango/entity/*.java src/de/uhilger/tango/store/*.java +$JDK/bin/jar -cf dist/tango.jar -C classes . +``` + +Die fertig verwendbare Anwendung liegt anschließend unter `$TANGO/dist/tango.jar` mit den erforderlichen Klassenbibliotheken im Ordner `$TANGO/dist/lib` . + +## Tango verwenden + +Installation, Ausführung und Bedienung von Tango beschreibt die [Anleitung](https://uhilger.de/data/pg/tango/doku/anleitung.adoc). ## Lizenz -Veröffentlicht unter den Bedingungen der [GNU Affero Genreal Public License](http://www.gnu.org/licenses/agpl-3.0) \ No newline at end of file +Veröffentlicht unter den Bedingungen der [GNU Affero General Public License](http://www.gnu.org/licenses/agpl-3.0) -- Gitblit v1.9.3