Add CMakePresets.json

.clangd

@@ -1,3 +1,3 @@
 CompileFlags:
-  CompilationDatabase: "build/"
+  CompilationDatabase: "build/debug"
 

.gitignore

@@ -12,6 +12,8 @@ sids/
 docs/html/
 unittests.log
 a.out
+.clangd
+.zed/settings.json
 
 # VisualStudioCode
 .vscode/settings.json
@@ -113,6 +115,7 @@ out.cereal
 
 # CMake
 cmake-build-*/
+build/
 
 # Mongo Explorer plugin
 .idea/**/mongoSettings.xml

CMakePresets.json

@@ -0,0 +1,66 @@
+{
+    "version": 6,
+    "cmakeMinimumRequired": {
+        "major": 3,
+        "minor": 24,
+        "patch": 0
+    },
+    "configurePresets": [
+        {
+            "name": "config-base",
+            "hidden": true,
+            "displayName": "Base Configuration",
+            "description": "Default build using unix makefile generator",
+            "generator": "Unix Makefiles",
+            "binaryDir": "${sourceDir}/build/${presetName}",
+            "cacheVariables": {
+                "CMAKE_EXPORT_COMPILE_COMMANDS": "on"
+            }
+        },
+        {
+            "name": "debug",
+            "displayName": "Config Debug",
+            "description": "Sets debug build type",
+            "inherits": "config-base",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Debug",
+                "ENABLE_PYTHON": "off",
+                "ENABLE_CACHE": "off"
+            }
+        },
+        {
+            "name": "relwithdebinfo",
+            "displayName": "Config Release with Debug Info",
+            "description": "Sets release with debug info build type",
+            "inherits": "debug",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "RelWithDebInfo"
+            }
+        },
+        {
+            "name": "release",
+            "displayName": "Config Release",
+            "description": "Sets release build type",
+            "inherits": "debug",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Release"
+            }
+        }
+    ],
+    "buildPresets": [
+        {
+            "name": "faunus-debug",
+            "displayName": "Faunus Debug Build",
+            "configurePreset": "debug",
+            "configuration": "Debug",
+            "targets": ["faunus"]
+        },
+        {
+            "name": "faunus-release",
+            "displayName": "Faunus Release Build",
+            "configurePreset": "release",
+            "configuration": "Release",
+            "targets": ["faunus"]
+        }
+    ]
+}

docs/_docs/install.md

@@ -153,6 +153,14 @@ make clean
 rm -fR CMakeCache.txt CMakeFiles _deps
 ~~~
 
+### CMake Presets
+
+CMake presets are provided and can be used e.g. like this:
+~~~ bash
+cmake --preset debug # populates build/debug/
+cmake --build --preset faunus-debug
+~~~
+
 ### Intel Threading Building Blocks (TBB)
 
 To use C++ parallel algorithms, some compilers require linkage with TBB.
@@ -189,12 +197,9 @@ code .
 ## Clangd
 
 For editors with `clangd` support, we provide a `.clangd` configuration file.
-This looks for a CMake generated `build` path that should contain
+This looks for a CMake generated `build/debug` path that should contain
 `compile_commands.json`.
-If you use a custom build directory, simply create a symlink called `build`
-in the project root.
-If your build directory doesn't contain `compile_commands.json`, you can create
-one with the CMake argument `-DCMAKE_EXPORT_COMPILE_COMMANDS=on`.
+Use `cmake . --preset debug` to generate.
 
 ## Code Style