X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=README.md;h=52e650368d4f3ddac3f42d77ad09aa7c23bf09d0;hb=refs%2Fchanges%2F42%2F1842%2F1;hp=cca05cd3b87287fec6635ddebf25f180969eb7e7;hpb=a0745d294dcd72f7d78ea4c3accd3b477dd668a5;p=ric-plt%2Fsdl.git diff --git a/README.md b/README.md index cca05cd..52e6503 100644 --- 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