From f510b5162268c7bd7dad67bd739f3ba548eade54 Mon Sep 17 00:00:00 2001
From: ulrich <undisclosed>
Date: Wed, 20 Nov 2024 15:18:36 +0000
Subject: [PATCH] Readme hinzugefuegt

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..473655f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# neon-fm
+
+Neon ist ein ultrakompakter HTTP-Server zum Einbetten in Apps und Microservices auf der Grundlage des Java-Moduls `jdk.httpserver`.
+
+Dieses Repository enthaelt das Modul zur Erweiterung von Neon um Funktionen fuer die Dateiverwaltung.
+
+Weitere Informationen auf der [Produktseite](https://uhilger.de/data/pg/neon/module/neon-fm.htmi)
+
+## Voraussetzungen
+
+Zur Herstellung von neon-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 neon-fm erhalten
+
+Der Quellcode von neon-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 `neon-fm` einschließlich des absoluten Pfades dorthin `$NEONFM` genannt. Anstelle von `$NEONFM` würde man also beispielweise `/home/fred/neon-fm` notieren, wenn in das persönliche Verzeichnis des Benutzers `fred` heruntergealden und entpackt wurde.
+
+## Abhängigkeiten
+
+neon-fm erfordert die Klassenbibliotheken 
+
+* [Gson](https://google.github.io/gson/) 
+* [neon](https://uhilger.de/gitblit/docs/web!neon.git) und 
+* [fm](https://uhilger.de/gitblit/docs/fm.git) 
+
+## Klassenbibliothek herstellen
+
+neon-fm ist zur Nutzung im Zusammenspiel mit anderen Programmen vorgesehen und wird dazu am besten als Klassenbibliothek genutzt. Es wird angenommen, dass die als Abhängigkeiten aufgeführten Bibliotheken lokal an einem Ort abgelegt sind, dessen Pfad mit dem Platzhalter `$JLIB` gemeint ist. Zur Herstellung einer Klassenbibliothek werden mit Hilfe der wie zuvor beschrieben geladenen Teile die folgenden Kommandos ausgeführt (Beispiel für Linux):
+
+```
+cd $NEONFM
+mkdir classes
+mkdir dist
+$JDK/bin/javac -classpath $JLIB/gson-2.8.6.jar:$JLIB/neon.jar:$JLIB/fm.jar -d classes src/de/uhilger/neon/fm/*.java 
+$JDK/bin/jar -cf dist/neon-fm.jar -C classes .
+```
+
+Die fertig verwendbare Klassenbibliothek liegt anschließend unter `$NEONFM/dist/neon-fm.jar`.
+
+## Klassenbibliothek verwenden
+
+Zur Verwendung der Klassen von neon-fm wird die Klassenbibliothek in den Classpath des Programmes aufgenommen, von dem aus neon-fm genutzt werden soll. 
+
+## Lizenz
+
+Veröffentlicht unter den Bedingungen der [GNU Affero General Public License](http://www.gnu.org/licenses/agpl-3.0)

--
Gitblit v1.9.3