Merge pull request #49 from saxbophone/develop

v0.11.3

Author: saxbophone

CMakeLists.txt

@@ -2,12 +2,12 @@
 cmake_minimum_required(VERSION 3.0)
 enable_language(C CXX)
 
-project(saxbospiral VERSION 0.11.1 LANGUAGES C)
+project(saxbospiral VERSION 0.11.3 LANGUAGES C)
 set(CMAKE_C_STANDARD 99)
 set(CMAKE_C_STANDARD_REQUIRED ON)
 set(
     SAXBOSPIRAL_VERSION_STRING
-    "v${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}"
+    "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}"
 )
 set(SAXBOSPIRAL_ESCAPED_VERSION_STRING "\"${SAXBOSPIRAL_VERSION_STRING}\"")
 # end basic metadata
@@ -96,11 +96,11 @@ if(COMMAND_INTERPRETER)
     add_test(
         NAME func_test COMMAND ${COMMAND_INTERPRETER}
         # each script needs to know the path to the sxp cli executable
-        "func_test.sh" sxp "saxbospiral ${SAXBOSPIRAL_VERSION_STRING}"
+        "func_test.sh" sxp "saxbospiral v${SAXBOSPIRAL_VERSION_STRING}"
     )
     add_custom_target(
         build_logo ${COMMAND_INTERPRETER}
-        "build_logo.sh" sxp "saxbospiral.png" "saxbospiral ${SAXBOSPIRAL_VERSION_STRING}"
+        "build_logo.sh" sxp "saxbospiral.png" "saxbospiral v${SAXBOSPIRAL_VERSION_STRING}"
     )
 else()
     # warn about skipping of functional test script

README.md

@@ -4,23 +4,42 @@ Experimental generation of 2D spiralling lines based on input binary data
 
 ## Dependencies
 
-You will need:
+### Library
+
+For the library, you will need:
 
 - A compiler that can compile C99 code
 - [Cmake](https://cmake.org/) - v3.0 or newer
 - [libpng](http://www.libpng.org/pub/png/libpng.html) - (this often comes preinstalled with many modern unix-like systems)
 
+### CLI
+
+For the included CLI program, you will also need:
+
+- [Argtable 2](http://argtable.sourceforge.net/) - must use v2, v1 and v3 will not work
+
 ### Note:
 
 These commands are for unix-like systems, without an IDE or other build system besides CMake. If building for a different system, or within an IDE or other environment, consult your IDE/System documentation on how to build CMake projects.
 
-## Build
+Additionally, it is of worth noting that this library has only been thoroughly tested and developed on Ubuntu GNU/Linux, although every effort has been made to make it as cross-platform as possible. It should compile under any POSIX-compliant system with the correct additional dependencies listed. **v0.8** is known to successfully cross-compile from Ubuntu to Windows (via [cygwin](https://www.cygwin.com/)) and Max OSX (using a locally-built compiler toolchain provided via [OSXCross](https://github.com/tpoechtrager/osxcross). It is highly likely that all other versions cross-compile as well (but I haven't yet verified this).
+
+## Basic Build
 
 ```sh
 cmake .
 make
 ```
 
+## Recommended Library Build
+
+Add two custom options to CMake to build the library in release mode (with full optimisation) and as a shared dynamic library:
+
+```sh
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON .
+make
+```
+
 ## Test
 
 ```sh

saxbospiral.png

@@ -82,7 +82,7 @@ write_png_image(bitmap_t bitmap) {
     metadata[2].text = "Copyright Joshua Saxby";
     metadata[3].key = "Software";
     // SAXBOSPIRAL_VERSION_STRING is a macro that expands to a double-quoted string
-    metadata[3].text = "SAXBOSPIRAL " SAXBOSPIRAL_VERSION_STRING;
+    metadata[3].text = "SAXBOSPIRAL v" SAXBOSPIRAL_VERSION_STRING;
     metadata[4].key = "Comment";
     metadata[4].text = "https://github.com/saxbophone/saxbospiral";
     // set compression of each metadata key

saxbospiral/render_backends/png_backend.c

@@ -41,8 +41,8 @@ load_spiral(buffer_t buffer) {
             .minor = buffer.bytes[13],
             .patch = buffer.bytes[14],
         };
-        // we don't accept anything over v0.11.x, so the max is v0.11.255
-        version_t max_version = { .major = 0, .minor = 11, .patch = 255, };
+        // we don't accept anything over v0.12.x, so the max is v0.12.255
+        version_t max_version = { .major = 0, .minor = 12, .patch = 255, };
         // check for version compatibility
         if(version_hash(buffer_version) > version_hash(max_version)) {
             // check failed

saxbospiral/serialise.c

@@ -134,7 +134,7 @@ run(
         if(spiral.size == 0) {
             fprintf(
                 stderr, "ERROR - File data was invalid (not a format accepted "
-                "by SAXBOSPIRAL " SAXBOSPIRAL_VERSION_STRING ")\n"
+                "by SAXBOSPIRAL v" SAXBOSPIRAL_VERSION_STRING ")\n"
             );
             return false;
         }
@@ -149,7 +149,7 @@ run(
         if(spiral.size == 0) {
             fprintf(
                 stderr, "ERROR - File data was invalid (not a format accepted "
-                "by SAXBOSPIRAL " SAXBOSPIRAL_VERSION_STRING ")\n"
+                "by SAXBOSPIRAL v" SAXBOSPIRAL_VERSION_STRING ")\n"
             );
             return false;
         }
@@ -240,7 +240,7 @@ main(int argc, char * argv[]) {
     int count_errors = arg_parse(argc, argv, argtable);
     // if we asked for the version, show it
     if(version->count > 0) {
-        printf("Saxbospiral " SAXBOSPIRAL_VERSION_STRING "\n");
+        printf("%s %s\n", program_name, SAXBOSPIRAL_VERSION_STRING);
         status_code = 0;
     }
     if(help->count > 0) {