Add CMake switches and documentation

Author: nicovank

src/CMakeLists.txt

@@ -32,6 +32,12 @@ target_link_libraries(litterer_static PRIVATE Threads::Threads)
 
 add_executable(microbenchmark-pages microbenchmark-pages.cpp)
 target_link_libraries(microbenchmark-pages PRIVATE Threads::Threads)
+if (MBP_OBJECT_DISTANCE)
+    target_compile_definitions(microbenchmark-pages PUBLIC OBJECT_DISTANCE=${MBP_OBJECT_DISTANCE})
+endif()
+if (MBP_OBJECT_SIZE)
+    target_compile_definitions(microbenchmark-pages PUBLIC OBJECT_SIZE=${MBP_OBJECT_SIZE})
+endif()
 
 if(NOT WIN32)
     message(STATUS "Downloading and configuring mimalloc")

src/REAMDE.md

@@ -0,0 +1,23 @@
+## Microbenchmark
+
+Here are instructions on running and tuning the `microbenchmark-pages` target.
+
+```bash
+# On Windows
+% cmake src -B build
+% cmake --build build --config Release
+% ./build/Release/microbenchmark-pages.exe
+
+# On other platforms
+% cmake src -B build -DCMAKE_BUILD_TYPE=Release
+% cmake --build build
+% ./build/microbenchmark-pages.exe
+
+# TODO: Maybe these can be merged into one, just needs testing.
+```
+
+Settings can be set using CMake at configuration time (the first step).
+
+```bash
+% cmake src -B build -DMBP_OBJECT_SIZE=32 -DMBP_OBJECT_DISTANCE=4096
+```