Feature:
Adapt documentation
Change-Id: I41cfed51e75868b51a6b3394d732e97f2d7580c8
Signed-off-by: Juergen G. Kissner <juergen.kissner@sap.com>
diff --git a/doc/.project b/doc/.project
new file mode 100644
index 0000000..53ca7b6
--- /dev/null
+++ b/doc/.project
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>doc</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ </buildSpec>
+ <natures>
+ </natures>
+</projectDescription>
diff --git a/doc/GettingStarted.txt b/doc/GettingStarted.txt
index 1be5d2a..3d3a29a 100644
--- a/doc/GettingStarted.txt
+++ b/doc/GettingStarted.txt
@@ -32,21 +32,28 @@
4. The Gemini DBAccess bundles
-There are typically two bundles for each supported database. The first bundle is the JDBC driver bundle
+There are typically three bundles for each supported database. The first bundle is the JDBC driver bundle
and includes the JDBC driver code. If a driver is already OSGi-ready then it should be bundlized
appropriately. If the driver is not already in an appropriate OSGi bundle then DBAccess will either provide
one, or explain how to create one, depending upon whether the driver JARs may be distributed or not.
-The second bundle is a DBAccess bundle that contains all of the logic to implement and register the
-DataSourceFactory service as specified by the OSGi JDBC specification.
+The second bundle is a DBAccess bundle that contains most of the logic to implement and register the
+DataSourceFactory service as specified by the OSGi JDBC specification. It is independent of the
+specifc JDBC driver.
+
+The third bundle is also a DBAccess bundle that contains the JDBC driver specific parts.
For example, the following bundles provide support for the Derby client/server database:
1. org.apache.derby - the derby JDBC driver jars
-2. org.eclipse.gemini.dbaccess.derby - the Gemini supporting classes for Derby
+2. org.eclipse.gemini.dbaccess.util - the Gemini supporting classes common to all JDBC drivers
+3. org.eclipse.gemini.dbaccess.derby - the Gemini supporting classes for Derby
*** Note: These bundles are shipped with Gemini DBAccess.
+
+
+
Maven Build
-----------
@@ -80,9 +87,17 @@
Installation
------------
-If running in PDE then import the various bundles (the framework will already be there) as plug-ins
-into your workspace. If you are not using PDE, but are using the framework directly then follow the
+If you use the Eclipse IDE, the easiest way to consume the bundles is the update site at
+http://www.eclipse.org/gemini/dbaccess/download/. Alternatively, if running in the
+Eclipse IDE you can also import the various bundles (the framework will already be there) as plug-ins
+into your workspace.
+
+If you are not using an (Eclipse) IDE, but are using the framework directly then follow the
documentation of the framework for installing the bundles.
-To run compile the projects in Eclipse, you have to open the gemini.dbaccess.targetdef project,
+
+Some Hints when Working with the Gemeini DBAccess Project
+--------------------------------------------------------
+
+To compile and run the projects in Eclipse, you have to open the gemini.dbaccess.targetdef project,
open the file gemini.dbaccess.target with the Target Editor and execute "Set as Target Platform"
diff --git a/doc/Readme.txt b/doc/Readme.txt
index ab056da..f81270f 100644
--- a/doc/Readme.txt
+++ b/doc/Readme.txt
@@ -1,14 +1,29 @@
-Gemini DBAccess Milestone M1 - July 26, 2010
+Gemini DBAccess 1.1 Milestone M1 - July 26, 2012
-This milestone provides you with database access to the server Derby database version 10.5.1.
+This milestone provides you with database access to the server Derby database version 10.8.2.2
To access other versions of Derby you may need to replace the derby.jar and derbyclient.jar
driver jars inside the org.apache.derby bundle with the version that you require.
For an example of how to access a database connection from an OSGi program run the sample program.
To do this, simply install and start the following bundles that are included in this distribution:
+Derby:
org.apache.derby
osgi.enterprise
org.eclipse.gemini.dbaccess.derby
+org.eclipse.gemini.dbaccess.util
org.eclipse.gemini.dbaccess.samples
+
+
+MySQL:
+osgi.enterprise
+org.eclipse.gemini.dbaccess.mysql
+org.eclipse.gemini.dbaccess.util
+org.eclipse.gemini.dbaccess.samples
+mysql-connector-java-5.1.20-bin.jar (not included, please download here: http://www.mysql.com/downloads/connector/j/)
+
+
+
+
+
