From 5dc55dd18caf0f64eb3c9312de658c0d6b4a085a Mon Sep 17 00:00:00 2001 From: ulrich Date: Tue, 17 Jan 2017 06:10:03 +0000 Subject: [PATCH] Dokumentation (in Arbeit) --- README.md | 22 ++++++++++++++++------ 1 files changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index da88722..95d7c0f 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,21 @@ # BaseLink -Alle Informationen auf der [Produktseite](http://uhilger.de/dev/Software/Libs/BaseLink/BaseLink) +Eine Klassenbibliothek für objekt-relationales Mapping und die damit verbundene Arbeit mit relationalen Datenbanken. Weitere Informationen auf der [Produktseite](http://uhilger.de/dev/Software/Libs/BaseLink/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 und Nutzung von BaseLink werden ein Java Development Kit (JDK) und der Quellcode von BaseLink benötigt. Das JDK ist z.B. von [Azul](http://azul.com) oder dem [OpenJDK-Projekt](http://openjdk.java.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): +## BaseLink erhalten + +Der Quellcode von BaseLink wird von hier an einen frei wählbaren lokalen Ablageort [heruntergeladen](http://uhilger.de/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 @@ -19,4 +25,8 @@ $JDK/bin/jar -cf dist/BaseLink.jar -C classes . ``` -Die fertig verwendbare Programmbibliothek liegt anschließend unter `$BASELINK/dist/BaseLink.jar`. \ No newline at end of file +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 auf der Seite [Nutzung](./master/nutzung.md) beschrieben. \ No newline at end of file -- Gitblit v1.9.3