Merge pull request #177 from saxbophone/develop

v0.27 - Measure CPU Time not Wall Clock Time

Author: saxbophone

.gitignore

@@ -42,3 +42,8 @@ Makefile
 cmake_install.cmake
 CTestTestfile.cmake
 install_manifest.txt
+
+# CMake build directory
+build/*
+# explicitly allow build directory .gitkeep file
+!build/.gitkeep

CMakeLists.txt

@@ -15,7 +15,7 @@
 # begin basic metadata
 cmake_minimum_required(VERSION 3.0)
 
-project(sxbp VERSION 0.26.1 LANGUAGES C)
+project(sxbp VERSION 0.27.0 LANGUAGES C)
 
 # set default C standard to use (C99) if not already set
 if(NOT DEFINED LIBSXBP_C_STANDARD)

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = libsxbp
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = v0.26
+PROJECT_NUMBER         = v0.27
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

README.md

@@ -60,10 +60,12 @@ There are no compulsory library dependencies beyond the C99 standard library. *Y
 
 ### Recommended Library Build
 
-Invoke CMake within the root of this repository, with these arguments to make CMake build the library in release mode (with full optimisation) and as a shared library:
+> An **out of source build** is recommended, as CMake clutters the directory it is executed in with many files which are awkward to remove.
+
+Invoke CMake within the `build` directory of this repository, with these arguments to make CMake build the library in release mode (with full optimisation) and as a shared library:
 
 ```sh
-cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON .
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON ..
 make
 ```
 
@@ -73,12 +75,12 @@ You can build in C11 mode if you want with either of the following:
 
 ```sh
 # using CMake variable
-cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DLIBSXBP_C_STANDARD=11 .
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DLIBSXBP_C_STANDARD=11 ..
 ```
 
 ```sh
 # using environment variable
-LIBSXBP_C_STANDARD=11 cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON .
+LIBSXBP_C_STANDARD=11 cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON ..
 ```
 
 Also, by default the CMake build script will look for libpng. If it cannot find it then it will disable support for PNG output.
@@ -87,12 +89,12 @@ You may choose to explicitly disable or enable PNG support with the `LIBSXBP_PNG
 
 ```sh
 # PNG support is required, build will fail if libpng can't be found
-cmake -DLIBSXBP_PNG_SUPPORT=ON .
+cmake -DLIBSXBP_PNG_SUPPORT=ON ..
 ```
 
 ```sh
 # PNG support is not included, even if libpng can be found
-cmake -DLIBSXBP_PNG_SUPPORT=OFF .
+cmake -DLIBSXBP_PNG_SUPPORT=OFF ..
 ```
 
 > ### Note:

build/.gitkeep

@@ -25,7 +25,7 @@
   <td id="projectlogo"><img alt="Logo" src="libsxbp.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">libsxbp
-   &#160;<span id="projectnumber">v0.26</span>
+   &#160;<span id="projectnumber">v0.27</span>
    </div>
    <div id="projectbrief">Experimental generation of 2D spiralling lines based on input binary data.</div>
   </td>

docs/annotated.html

@@ -25,7 +25,7 @@
   <td id="projectlogo"><img alt="Logo" src="libsxbp.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">libsxbp
-   &#160;<span id="projectnumber">v0.26</span>
+   &#160;<span id="projectnumber">v0.27</span>
    </div>
    <div id="projectbrief">Experimental generation of 2D spiralling lines based on input binary data.</div>
   </td>
@@ -104,8 +104,8 @@
 <div class="dyncontent">
 <div class="center"><img src="backend__pbm_8h__incl.png" border="0" usemap="#sxbp_2render__backends_2backend__pbm_8h" alt=""/></div>
 <map name="sxbp_2render__backends_2backend__pbm_8h" id="sxbp_2render__backends_2backend__pbm_8h">
-<area shape="rect" id="node2" href="saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="27,169,138,196"/>
-<area shape="rect" id="node6" href="render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="131,95,213,121"/>
+<area shape="rect" id="node2" href="saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="78,169,189,196"/>
+<area shape="rect" id="node7" href="render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="182,95,263,121"/>
 </map>
 </div>
 </div>

docs/backend__pbm_8h.html

@@ -1,4 +1,4 @@
 <map id="sxbp/render_backends/backend_pbm.h" name="sxbp/render_backends/backend_pbm.h">
-<area shape="rect" id="node2" href="$saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="27,169,138,196"/>
-<area shape="rect" id="node6" href="$render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="131,95,213,121"/>
+<area shape="rect" id="node2" href="$saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="78,169,189,196"/>
+<area shape="rect" id="node7" href="$render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="182,95,263,121"/>
 </map>

docs/backend__pbm_8h__incl.map

@@ -1 +1 @@
-3dfb6ae624b8e29e3b0371a593b57e64
+ae0da03ff880d26982d479c9613fcf06