updated persistence benchmark

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

diff --git a/README b/README
index e69de29..3dbac83 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,22 @@
+----------------------------
+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. 
+
+
+
+