-Requirements
-To build the RMR libraries, NNG must be installed, or the external references
-in the source tree must be used to pull and build the NNG library. It might
-be necessary to alter the values of C_INCLUDE_PATH, LD_LIBRARY_PATH, or
-LIBRARY_PATH to reflect the instalation location when the installed version
-ot NNG is being used.
-
-To install see the instructions on their html sites:
- https://github.com/nanomsg/nng
-
-The default CMake build will not require NNG to be installed, and this is the
-easiest way to build.
-
-Unit Testing
-The script ../test/unit_test.ksh should be used for running unit tests. With no
-parameters it will attempt to build any file in this directory which has the
-name *_test.c. Build is attempted with either mk or make and enables the
-necessary compiler flags to support coverage output (gcov). Once built, the
-test programme is executed and if the return code is success (0), the
-coverage data is interpreted.
-
-The test programmes may make use of ../test/tools.c which provide simple
-validation check functions. These programmes shouild also directly include
-the module(s) under test. This ensures that they are not linked, and are
-compiled with the proper coverage flags. In addition, it allows modules that
-are not under test to be linked from the archive and (most importantly) not
-reported on from a coverage perspective. In cases where two modules depend on
-each other, and are static functions, they will need to be tested from a single
-unit test programme (see the rt_tool test programme).
-
-It might be necessary to write a higher level test driver as some of the modules
-(e.g. route table) have threaded daemons which might not be easy to drive
-completely or at all, and thus the code coverage for a passing test might need
-to be lower for this type of module.
-
-Containerized Build
-The Dockerfile defines an environment to build and test this library. It uses
-a base image with the C toolchain. The Dockerfile is NOT intended to create a
-distributable image.