Merge pull request #217 from ggbecker/improve-build-documentation

Improve custom build documentation.

Author: yuumasato

README.md

@@ -35,18 +35,33 @@ optional dependencies:
 2) Build SCAP Workbench:
 ```console
 $ mkdir build; cd build
-$ # This export line is only required if openscap was compiled locally;
-$ # add to PKG_CONFIG_PATH the directory containing installed libopenscap.pc
-$ export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/PATH/TO/DIR/WITH/.pcFILE/"
 $ cmake ../
 $ make
 ```
+To build against locally built OpenSCAP library export following variables:
+
+```console
+$ export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/PATH/TO/DIR/WITH/.pcFILE/"
+$ export LIBRARY_PATH=/PATH/TO/DIR/WITH/openscap.soFILE/
+```
+
+Additionally it is possible to use custom CMake definitions instead of exporting environment variables:
+
+```console
+$ cmake -DOPENSCAP_LIBRARIES:PATH=/local/openscap.so/filepath/ \
+    -DOPENSCAP_INCLUDE_DIRS:PATH=/local/openscap/include/path \
+    -DOPENSCAP_VERSION:STRING="X.Y.Z" \
+    ../
+$ make
+```
 
 3) Install SCAP Workbench: (optional)
 
 (inside the build folder):
 ```console
-# make install
+$ # may require superuser privileges if you didn't set different installation
+$ # prefix (CMAKE_INSTALL_PREFIX)
+$ make install
 ```
 
 4a) Run SCAP Workbench: (if it was installed)
@@ -68,6 +83,18 @@ $ scap-workbench /path/to/sds-file
 
 4b) Run SCAP Workbench: (straight from build dir, without installation)
 
+Note: If you have built SCAP-Workbench against locally built OpenSCAP library, then run one of the following commands:
+
+```console
+$ ldconfig /PATH/TO/DIR/WITH/openscap.soFILE/
+```
+or
+```console
+$ export LD_LIBRARY_PATH=/PATH/TO/DIR/WITH/openscap.soFILE/
+```
+
+and then:
+
 ```console
 $ cd build/
 $ bash runwrapper.sh ./scap-workbench