From 3bf5221ecb15a8ed5caecfe92bb3e0c111107949 Mon Sep 17 00:00:00 2001 From: ulrich Date: Mon, 22 Jan 2024 14:04:53 +0000 Subject: [PATCH] Kommentare ergaenzt --- README.md | 29 +++++++++++++++++++++-------- 1 files changed, 21 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8d931fb..c6890f0 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,32 @@ # BaseLink -Alle Informationen auf der [Produktseite](http://uhilger.de/dev/Software/Libs/BaseLink/BaseLink) +BaseLink vereinfacht die Nutzung von Datenbanken mit Java. Weitere Informationen auf der [Produktseite](https://uhilger.de/data/pg/baselink/). -## Java-Bibliothek herstellen +## Voraussetzungen -Zum Herstellen der Java-Bibliothek wird ein Java Development Kit (JDK) benötigt, wie es z.B. von [Azul](http://azul.com) oder dem [OpenJDK-Projekt](http://openjdk.java.net/) erhältlich ist. In der hier folgenden weiteren Beschreibung wird der lokale Ablageort des Java Development Kits `$JDK` genannt. +Zur Herstellung von BaseLink aus dem Quellcode wird ein Java Development Kit (JDK) benötigt. Das JDK ist von [AdoptOpenJDK](https://adoptopenjdk.net/) frei erhältlich. In der hier folgenden weiteren Beschreibung wird der lokale Ablageort des Java Development Kits `$JDK` genannt. -Zur Herstellung der Programmbibliothek von BaseLink mit dem JDK wird zunächst der Quellcode aus diesem Git-Repository [heruntergeladen](http://uhilger.de/gitblit/zip/?r=BaseLink.git&format=zip), entpackt und an einem frei wählbaren Ablageort gespeichert. In der hier folgenden weiteren Beschreibung wird der lokale Ablageort des Quellcodes von BaseLink `$BASELINK` genannt. +BaseLink setzt auf die Java Database Connectivity (JDBC) auf. Zum Zugriff auf Datenbanken benötigen Programme zur Laufzeit einen passenden JDBC-Treiber wie er vom Hersteller der betreffenden Datenbanken bereitgestellt wird. -Sind `$JDK` und `$BaseLink` lokal vorhanden, wird die Programmbibliothek für BaseLink mit den folgenden Kommandos erstellt (Beispiel für Linux): +## Quellcode von BaseLink erhalten -cd `$BASELINK` +Der Quellcode von BaseLink wird von hier an einen frei wählbaren lokalen Ablageort [heruntergeladen](/gitblit/zip/?r=BaseLink.git&format=zip) und entpackt. In der hier folgenden weiteren Beschreibung wird das so entstandene Verzeichnis `BaseLink` einschließlich des absoluten Pfades dorthin `$BASELINK` genannt. Anstelle von `$BASELINK` würde man also beispielweise `/home/fred/BaseLink` notieren, wenn in das persönliche Verzeichnis des Benutzers `fred` heruntergealden und entpackt wurde. + +## Klassenbibliothek herstellen + +BaseLink 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 $BASELINK mkdir classes mkdir dist -`$JDK`/bin/javac -d classes src/de/uhilger/baselink/*.java -`$JDK`/bin/jar -cf dist/BaseLink.jar -C classes . +$JDK/bin/javac -d classes src/de/uhilger/baselink/*.java +$JDK/bin/jar -cf dist/BaseLink.jar -C classes . +``` +Die fertig verwendbare Klassenbibliothek liegt anschließend unter `$BASELINK/dist/BaseLink.jar`. + +## Klassenbibliothek verwenden + +Zur Verwendung der Klassen von BaseLink wird die Klassenbibliothek in den Classpath des Programmes aufgenommen, von dem aus BaseLink genutzt werden soll. Details zur Nutzung von BaseLink sind in der [Anleitung](https://uhilger.de/data/pg/baselink/anleitung.adoc) beschrieben. \ No newline at end of file -- Gitblit v1.9.3