Add SDL developer and user guides

[ric-plt/sdl.git] / README.md

diff --git a/README.md b/README.md
index 96d751e..52e6503 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,7 +10,9 @@
 
 ## Documentation
 
-Documentation is generated with `doxygen` tool.
+Documentation is generated with `doxygen` tool. Dependency to `doxygen`
+tool is optional. If not installed, then `doxygen-doc` target will not
+be created to Makefile.
 
 By default `make doxygen-doc` creates HTML, PDF and PS documents (if
 the needed tools are available). The documents are created to:
@@ -33,10 +35,23 @@ directory named `shareddatalayer`.
 
 ### Dependencies
 
-Currently, the following libraries are required while building:
+Build-time dependencies:
 
-    boost-devel
-    hiredis-devel
+    boost
+    hiredis
+    doxygen (optional)
+
+Commands to install dependent packages in Fedora:
+
+    sudo dnf install boost-devel
+    sudo dnf install hiredis-devel
+    sudo dnf install doxygen
+
+Commands to install dependent packages in Debian/Ubuntu:
+
+    sudo apt install libboost-all-dev
+    sudo apt install libhiredis-dev
+    sudo apt install doxygen
 
 ### Compilation in the source directory
 
@@ -61,7 +76,11 @@ By default the shared library is installed to `/usr/local/lib` and
 headers into to `/usr/local/include`. If this is not desired, then
 provide different path when running `configure`, for example:
 
-    ./configure --prefix=$HOME
+    ./configure --prefix=$HOME/usr/local
+
+In above example SDL pkg-config .pc file is installed to `$HOME/usr/local/lib/pkgconfig`
+directory. This directory should be included to `PKG_CONFIG_PATH` while building
+the application which is using the SDL API library.
 
 Note that `configure` command allows plethora of additional options.
 For more info:
@@ -72,6 +91,11 @@ After configuration has been done, run:
 
     make install
 
+In some cases dynamic linker cache needs to be manually refreshed after SDL API
+has been re-installed:
+
+    ldconfig
+
 ### Redis modules
 
 When Redis is used, SDL requires that the following Redis extension commands