Ultrakompakter HTTP Server
ulrich
2024-12-01 40f0b0d27ec38c97fadb4c64dba6855c6ee2e904
README.md
@@ -4,6 +4,36 @@
Weitere Informationen auf der [Produktseite](https://uhilger.de/data/pg/neon/)
## Voraussetzungen
Zur Herstellung von neon 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 erhalten
Der Quellcode von neon 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` einschließlich des absoluten Pfades dorthin `$NEON` genannt. Anstelle von `$NEON` würde man also beispielweise `/home/fred/neon` notieren, wenn in das persönliche Verzeichnis des Benutzers `fred` heruntergealden und entpackt wurde.
## Abhängigkeiten
neon erfordert die Klassenbibliothek [Gson](https://google.github.io/gson/).
## Klassenbibliothek herstellen
neon ist zur Nutzung im Zusammenspiel mit anderen Programmen vorgesehen und wird dazu am besten als Klassenbibliothek genutzt. Es wird angenommen, dass die oben aufgeführte Bibliothek lokal an einem Ort abgelegt ist, 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 $NEON
mkdir classes
mkdir dist
$JDK/bin/javac -classpath $JLIB/gson-2.8.6.jar -d classes src/de/uhilger/neon/*.java src/de/uhilger/neon/entity/*.java
$JDK/bin/jar -cf dist/neon.jar -C classes .
```
Die fertig verwendbare Klassenbibliothek liegt anschließend unter `$NEON/dist/neon.jar`.
## Klassenbibliothek verwenden
Zur Verwendung der Klassen von neon wird die Klassenbibliothek in den Classpath des Programmes aufgenommen, von dem aus neon genutzt werden soll.
## Lizenz
Veröffentlicht unter den Bedingungen der [GNU Affero General Public License](http://www.gnu.org/licenses/agpl-3.0)