Use cmake presets and make configuration, building and testing a breeze.

Author: HackTheOxidation

.gitignore

@@ -10,3 +10,4 @@ dist
 CMakeCache.txt
 CMakeFiles
 compile_commands.json
+Testing

CMakeLists.txt

@@ -59,4 +59,4 @@ set(installable_libs os2dsrules os2dsrules_compiler_flags)
 install(TARGETS ${installable_libs} DESTINATION lib)
 
 # Install header files on system.
-install(FILES include/os2dsrules.hpp include/cpr-detector.hpp include/data_structures.hpp include/name_rule.hpp wordlist_rule.hpp DESTINATION include)
+install(FILES include/os2dsrules.hpp include/cpr-detector.hpp include/data_structures.hpp include/name_rule.hpp include/wordlist_rule.hpp DESTINATION include)

CMakePresets.json

@@ -0,0 +1,67 @@
+{
+    "version": 6,
+    "cmakeMinimumRequired": {
+	"major": 3,
+	"minor": 20,
+	"patch": 0
+    },
+    "configurePresets": [
+	{
+	    "name": "default-debug",
+	    "displayName": "Default Debug configuration preset",
+	    "generator": "Ninja",
+	    "binaryDir": "${sourceDir}/build_cmake/debug",
+	    "installDir": "/usr/",
+	    "cacheVariables": {
+		"CMAKE_BUILD_TYPE": "Debug"
+	    }
+	},
+	{
+	    "name": "default-release",
+	    "displayName": "Default Release configuration preset",
+	    "generator": "Ninja",
+	    "binaryDir": "${sourceDir}/build_cmake/release",
+	    "installDir": "/usr/",
+	    "cacheVariables": {
+		"CMAKE_BUILD_TYPE": "Release"
+	    }
+	}
+    ],
+    "buildPresets": [
+	{
+	    "name": "os2ds-rules-debug",
+	    "displayName": "os2ds-rules Debug build preset",
+	    "verbose": true,
+	    "configurePreset": "default-debug"
+	},
+	{
+	    "name": "os2ds-rules-release",
+	    "displayName": "os2ds-rules Release build preset",
+	    "configurePreset": "default-release"
+	}
+    ],
+    "testPresets": [
+	{
+	    "name": "test-debug",
+	    "configurePreset": "default-debug",
+	    "output": {
+		"outputOnFailure": true
+	    },
+	    "execution": {
+		"noTestsAction": "error",
+		"stopOnFailure": true
+	    }
+	},
+	{
+	    "name": "test-release",
+	    "configurePreset": "default-release",
+	    "output": {
+		"outputOnFailure": true
+	    },
+	    "execution": {
+		"noTestsAction": "error",
+		"stopOnFailure": true
+	    }
+	}
+    ]
+}

README.md

@@ -22,7 +22,8 @@ You can install either or both of the `C++` library or the `python` extension.
 For the `C++` library you need a few different things:
 
 - A compiler that supports `C++20`. We recommend using either `g++` (GCC) or `clang` (LLVM).
-- `cmake>=3.20`: Primary build system.
+- `cmake>=3.20`: Primary (meta) build system.
+- `ninja`: Cross-platform backend for cmake.
 - `gtest` (Google Test): For building and running the test suite.
 
 For development, you additionally want:
@@ -36,32 +37,29 @@ To build, run the following:
 
 ```sh
 # Make a build directory 
-mkdir build_cmake
-cd build_cmake
-cmake -DCMAKE_BUILD_TYPE=Release ..  # or use 'Debug' for development.
-cmake --build .
+cmake . --preset default-debug
+cmake --build --preset os2ds-rules-debug
 ```
 
 This will build the shared library `libos2dsrules.so` and the test suite `testsuite`.
 
 To install the library, run the following from the build directory:
 
 ```sh
-sudo make install
+sudo cmake --install build_cmake/debug
 ```
 
-By default, this will install headers into `/usr/local/include` and shared objects to
-`/usr/local/lib`. Make sure your include path and `LD_LIBRARY_PATH` is configured
-properly. You can run: `export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH` to
-configure the library load path.
+By default, this will install headers into `/usr/include` and shared objects to
+`/usr/lib`. 
 
 To run the test suite:
 
 ```sh
-ctest --output-on-failure
+ctest --preset test-debug
 ```
 
-Currently, this has only been tested on `linux` and it should work on `macOS` as well.
+Currently, this has only been tested on `linux`, but it should work on `macOS` as well.
+It remains to be tested on windows.
 
 ### The Python extension: `os2ds-rules`