From 20b936641b5f34ee8101d870c2c83ebcbd7dc9bf Mon Sep 17 00:00:00 2001 From: ulrich Date: Fri, 22 Nov 2024 18:40:01 +0000 Subject: [PATCH] readme angepasst. --- README.md | 30 ++++++++++++++++++++++++------ 1 files changed, 24 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 23cab5d..cac1059 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,35 @@ Weitere Informationen auf der [Produktseite](https://uhilger.de/data/pg/tango/). -## Abhängigkeiten +## Voraussetzungen -Tango nutzt und erfordert die folgenden Produkte: +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. -[Java](https://adoptopenjdk.net/) - Ablaufumgebung +Tango erfordert darüber hinaus die folgenden Klassenbibliotheken: + [Gson](https://github.com/google/gson) - JSON/Java Serialisierung und Deserialisierung [jID3Lib](http://javamusictag.sourceforge.net/) - Java ID3 Tag Library -[Mustache](http://mustache.github.io/) - "Logic-less templates." -[RobotoRegular](https://fonts.google.com/specimen/Roboto) - Schriftart -Die obigen Bestandteile sind im Auslieferungspaket enthalten. Im Falle der Verwendung des Quellcodes für eigene / andere Zwecke müssen diese allerdings selbst beschafft und hinzugefügt werden. +Die benötigten Klassenbibliotheken 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." +[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. + +## 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. + +## 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 wird nach dem Herunterladen das [Buildscript](https://uhilger.de/gitblit/blob/tango.git/master/publish!build.sh) angepasst (Pfadangaben) und ausgefuehrt. + +Die fertig verwendbare Anwendung liegt anschließend unter `$TANGO/dist` als `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 -- Gitblit v1.9.3