readme and examples #22 #26

.circleci/Dockerfile.test

@@ -3,5 +3,13 @@ FROM matthewjamesbriggs/mxci:v001
 ENV BASEDIR="/mx"
 WORKDIR $BASEDIR
 COPY . .
-CMD cmake -DMX_BUILD_TESTS=on -DMX_BUILD_CORE_TESTS=on . && make -j12 && ./MxTest
+CMD cmake \
+    -DMX_BUILD_TESTS=on \
+    -DMX_BUILD_CORE_TESTS=on \
+    -DMX_BUILD_EXAMPLES=on \
+    . && \
+    make -j12 && \
+    ./MxTest && \
+    ./MxRead && \
+    ./MxWrite
 # CMD cmake --version

.circleci/config.yml

@@ -47,13 +47,17 @@ jobs:
           name: Cmake
           command: |
               [ "$(git rev-parse --abbrev-ref HEAD)" == "master" ] && \
-              cmake -DMX_BUILD_TESTS=on -DMX_BUILD_CORE_TESTS=on . || \
-              cmake -DMX_BUILD_TESTS=on -DMX_BUILD_CORE_TESTS=off .
+              cmake -DMX_BUILD_EXAMPLES=on -DMX_BUILD_TESTS=on -DMX_BUILD_CORE_TESTS=on . || \
+              cmake -DMX_BUILD_EXAMPLES=on -DMX_BUILD_TESTS=on -DMX_BUILD_CORE_TESTS=off .
 
       - run:
           name: Build
           command: make
 
+      - run:
+          name: Run Examples
+          command: ./MxRead && ./MxWrite
+
       - run:
           name: Test
           command: ./MxTest

CMakeLists.txt

@@ -91,3 +91,22 @@ if(MX_BUILD_TESTS)
 else()
   message("tests will not be compiled")
 endif()
+
+# MxExamples
+if(MX_BUILD_EXAMPLES)
+    message("examples will be compiled")   
+    find_package( Threads )
+    add_executable(MxRead ${SOURCE}/mx/examples/Read.cpp)
+    add_executable(MxWrite ${SOURCE}/mx/examples/Write.cpp)
+    target_link_libraries(MxRead Mx  ${CMAKE_THREAD_LIBS_INIT})
+    target_link_libraries(MxWrite Mx ${CMAKE_THREAD_LIBS_INIT})
+    set_property(TARGET MxRead PROPERTY CXX_STANDARD 14)
+    set_property(TARGET MxWrite PROPERTY CXX_STANDARD 14)
+
+    # TODO - create a proper 'include' directory
+    target_include_directories(MxRead PRIVATE ${SOURCE}/mx/api)
+    target_include_directories(MxWrite PRIVATE ${SOURCE}/mx/api)
+
+else()
+  message("examples will not be compiled")
+endif()