updated persistence benchmark

[profile/ivi/persistence-client-library.git] / README

diff --git a/README b/README
index 88085cb..3dbac83 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,22 @@
-Environment
-The Persistence Client Library has been developed using Ubuntu 11.10
-
-Required packages
-* automotive-dlt: available via GENIVI projects ==> http://git.projects.genivi.org/?p=dlt-daemon.git;a=summary
-* Itzam/C: download from here ==> http://www.coyotegulch.com/products/itzam/c/index.html
-* dbus-1: install via Synaptic Package Manger or use apt-get
-* autotools: install via Synaptic Package Manger or use apt-get
-* GNU c compiler: install via Synaptic Package Manger or use apt-get
-
-How to compile
-For the Persistence Client Library autotools will be used to generate makefiles.
-To build the client library perform the following steps:
-* "autoreconf -vi"
-* "./configure –enable-tests"
-* "make"
+----------------------------
+Documentation
+----------------------------
+For details about the Persistence Client Library, please refer to to following documents:
+
+- Persistence Client Library Architecture Documentation:
+  http://docs.projects.genivi.org/persistence-client-library/1.0/GENIVI_Persistence_ArchitectureDocumentation.pdf
+
+- Persistence Client Library User Manual: 
+  http://docs.projects.genivi.org/persistence-client-library/1.0/GENIVI_Persistence_Client_Library_UserManual.pdf
+
+
+----------------------------
+How to create doxygen documentation
+----------------------------
+
+The doxygen package must be installed.
+run "doxygen doc/pcl_doxyfile" and the html documentation will be generated in the doc folder. 
+
+
+
+