cmake: change default CMAKE_BUILD_TYPE to RelWithDebInfo

in the past some users run e.g. benchmarks and was surprised with
the results. Using release version should omit that problem.
Documentation is updated as well to point users with proper CMake parameter.

Author: lukaszstolarczuk

CMakeLists.txt

@@ -41,7 +41,7 @@ set(TEST_DIR ${CMAKE_CURRENT_BINARY_DIR}/test CACHE STRING "working directory fo
 message(STATUS "TEST_DIR set to: \"${TEST_DIR}\"")
 
 if(NOT CMAKE_BUILD_TYPE)
-	set(CMAKE_BUILD_TYPE "Debug")
+	set(CMAKE_BUILD_TYPE "RelWithDebInfo")
 endif()
 
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${LIBPMEMOBJCPP_ROOT_DIR}/cmake)

ChangeLog

@@ -9,6 +9,8 @@ XXX Igor Chorążewicz <igor.chorazewicz@intel.com>
 	-
 
 	Other changes:
+	- Switched default CMake's build type from "Debug" to "RelWithDebInfo"
+		it's relevant for a GitHub users (who may e.g. run some benchmarks)
 	-
 
 Mon Feb 15 2021 Igor Chorążewicz <igor.chorazewicz@intel.com>

README.md

@@ -86,7 +86,7 @@ You will need the following packages for compilation:
 ```
 $ mkdir build
 $ cd build
-$ cmake .. [-DCMAKE_INSTALL_PREFIX=<path_to_installation_dir>]
+$ cmake .. [-DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=<path_to_installation_dir>]
 $ make
 # make install
 ```