New cluster

CMakeLists.txt

@@ -21,9 +21,11 @@ macro(janus_get_version VAR)
        REGEX "#define[ ]+${VAR}[ ]+[0-9]+")
   string(REGEX MATCH "[0-9]+" ${VAR} ${LINE})
 endmacro(janus_get_version)
+
 janus_get_version(JANUS_VERSION_MAJOR)
 janus_get_version(JANUS_VERSION_MINOR)
 janus_get_version(JANUS_VERSION_PATCH)
+
 configure_file(include/iarpa_janus.h ${CMAKE_CURRENT_BINARY_DIR}/refreshes_version_when_changed)
 set(JANUS_VERSION ${JANUS_VERSION_MAJOR}.${JANUS_VERSION_MINOR}.${JANUS_VERSION_PATCH})
 
@@ -34,6 +36,16 @@ endif()
 
 include(CTest)
 
-if(JANUS_IMPLEMENTATION AND JANUS_IO_IMPLEMENTATION)
-  add_subdirectory(src)
+# The harness includes an optional PittPatt5 implementation
+add_subdirectory(implementations)
+
+# If we have an implementation, build the test harness
+if(JANUS_IMPLEMENTATION)
+  add_subdirectory(harness)
+endif()
+
+# Optionally build the documentation
+option(BUILD_JANUS_DOCUMENTATION "Use doxygen to build the Janus documentation" OFF)
+if (${BUILD_JANUS_DOCUMENTATION})
+  add_subdirectory(docs)
 endif()

README.md

@@ -14,20 +14,20 @@ Janus
 
 # Implementations
 
-The Janus CMake file expects the user to specify a JANUS_IMPLEMENTATION variable that gives the name of the library the Janus utility executables can link against at compile time. Using PittPatt 5 as an example, the command to cmake would be
+The Janus CMake file expects the user to specify a JANUS_IMPLEMENTATION variable that gives the full path to the library that contains the implementations of the API functions. This can be done like:
 
-    $ cmake -DJANUS_IMPLEMENTATION="pittpatt" ..
+    $ cmake -DJANUS_IMPLEMENTATION="/path/to/janus/implementation" ..
 
-In addition to a JANUS_IMPLEMENTATION, users may also optionally specify a JANUS_IO_IMPLEMENTATION which implements the Janus I/O functions. A working version that uses the OpenCV library comes with the API. The command to use it is 
+In addition to a JANUS_IMPLEMENTATION, users may also optionally specify a JANUS_IO_IMPLEMENTATION which implements the Janus I/O functions. Similar to JANUS_IMPLEMENTATION it can be set like: 
 
-    $ cmake -DJANUS_IO_IMPLEMENTATION="opencv_io" ..
+    $ cmake -DJANUS_IO_IMPLEMENTATION="/path/to/janus/io/implementation" ..
 
 # Building the PittPatt wrapper
 
-To build the PittPatt 5 wrapper you would use the cmake command
+This API ships with an optional PittPatt 5 wrapper that can be used to test the functionality. Note that the wrapper requires the PittPatt 5 libaries to be provided separately. To build the PittPatt 5 wrapper you would use the cmake command
 
-    $ cmake -DJANUS_IMPLEMENTATION="pittpatt" -DJANUS_IO_IMPLEMENTATION="opencv_io" ..
+    $ cmake -DBUILD_JANUS_PP5_IMPLEMENTATION=ON -DBUILD_JANUS_OPENCV_IO_IMPELEMENTATION=ON ..
 
-CMake will automatically try and locate the PittPatt libraries on your system. If they cannot be found you can manually set the PP5_DIR variable, either from the command line or using the CMake GUI. Setting it from the command line can be done like 
+CMake will automatically try and locate the PittPatt and OpenCV libraries on your system. If they cannot be found you will be manually prompted to provide the PP5_DIR and OpenCV_DIR variables. The PP5_DIR should point to the root of the PittPatt 5 SDK directory. The OpenCV_DIR should point to the directory that contains OpenCVConfig.cmake. From the command line these values can be set like
 
-    $ cmake -DPP5_DIR=/path/to/pp5 ..
+    $ cmake -DPP5_DIR=/path/to/pp5 -DOpenCV_DIR=/path/to/opencv ..