From 1be785f6df00e3f36c00b58a2d0c623733c74621 Mon Sep 17 00:00:00 2001
From: ulrich
Date: Thu, 14 Nov 2024 13:29:33 +0000
Subject: [PATCH] package-info auf den neuesten Stand gebracht

---
 README.md |   36 ++++++++++++++++++++++++++++++++++++
 1 files changed, 36 insertions(+), 0 deletions(-)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ab5eb0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# fm
+
+Eine Klassenbibliothek zur Dateiverwaltung.
+
+Weitere Informationen auf der [Produktseite](https://uhilger.de/data/pg/fm/)
+
+## Voraussetzungen
+
+Zur Herstellung von fm 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 fm erhalten
+
+Der Quellcode von fm wird von hier an einen frei wählbaren lokalen Ablageort heruntergeladen und entpackt. In der hier folgenden weiteren Beschreibung wird das so entstandene Verzeichnis `fm` einschließlich des absoluten Pfades dorthin `$FM` genannt. Anstelle von `$BASELINK` würde man also beispielweise `/home/fred/fm` notieren, wenn in das persönliche Verzeichnis des Benutzers `fred` heruntergealden und entpackt wurde.
+
+## Klassenbibliothek herstellen
+
+fm ist zur Nutzung im Zusammenspiel mit anderen Programmen vorgesehen und wird dazu am besten als Klassenbibliothek genutzt. Zur Herstellung einer Klassenbibliothek werden mit Hilfe der wie zuvor beschrieben geladenen Teile die folgenden Kommandos ausgeführt (Beispiel für Linux):
+
+```
+cd $FM
+mkdir classes
+mkdir dist
+$JDK/bin/javac -d classes src/de/uhilger/fm/*.java
+$JDK/bin/jar -cf dist/fm.jar -C classes .
+```
+
+Die fertig verwendbare Klassenbibliothek liegt anschließend unter `$FM/dist/fm.jar`.
+
+## Klassenbibliothek verwenden
+
+Zur Verwendung der Klassen von fm wird die Klassenbibliothek in den Classpath des Programmes aufgenommen, von dem aus fm genutzt werden soll. Neben fm wird zudem die Klassenbibliothek [Gson](https://google.github.io/gson/) benötigt.
+
+
+## Lizenz
+
+Veröffentlicht unter den Bedingungen der [GNU Affero General Public License](http://www.gnu.org/licenses/agpl-3.0)

--
Gitblit v1.9.3