Use Cmake

.github/workflows/check.yml

@@ -3,23 +3,33 @@ on: push
 
 jobs:
   check:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest, macos-latest]
+        include:
+          - os: windows-latest
+            path_to_exe: ./build/Debug/RangeShifter.exe
+          - os: ubuntu-latest
+            path_to_exe: ./build/RangeShifter
+          - os: macos-latest
+            path_to_exe: ./build/RangeShifter
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
 
       - name: build
-        run: g++ -o ./run_on_gha/rs_test_project/rs.exe ./src/*.cpp ./src/RScore/*.cpp
-
-      - name: run
         run: |
-          cd ./run_on_gha/rs_test_project
-          ./rs.exe
+          mkdir build
+          cd build
+          cmake ../
+          cmake --build .
+
+      - name: run
+        run: ${{ matrix.path_to_exe }} run_on_gha/rs_test_project/
 
       - name: check_output
         run: |
-          cd ./run_on_gha/rs_test_project 
+         cd ./run_on_gha/rs_test_project 
           rm Outputs/DebugLog.txt
           bash check_output.bash
         # DebugLog contains addresses, changes every run
-
-

.gitignore

@@ -2,6 +2,7 @@
 # CodeLite
 /.build-debug/
 /build-Debug/
+/build/
 /Debug/
 /Release/
 RNG_test/
@@ -56,6 +57,8 @@ Bacup*/
 .vs/
 *.sln
 *.vcxproj*
+out/
+x64/
 
 # Ignore test project outputs, except anchors
 run_on_gha/rs_test_project/Outputs/*

CMakeLists.txt

@@ -0,0 +1,27 @@
+cmake_minimum_required(VERSION 3.10)
+
+# set the project name and version
+project(RangeShifter VERSION 2.1.0)
+
+# specify the C++ standard
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED True)
+
+# add RScore to source search path
+add_subdirectory(src/RScore)
+
+# add the executable
+add_executable(RangeShifter src/Main.cpp src/BatchMode.cpp)
+
+# enable LINUX_CLUSTER macro on Linux + macOS
+if(CMAKE_SYSTEM_NAME STREQUAL "Linux" OR CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+	target_compile_definitions(RangeShifter PRIVATE "RSDEBUG" "RSWIN64" "LINUX_CLUSTER")
+else() # Windows
+	target_compile_definitions(RangeShifter PRIVATE "RSDEBUG" "RSWIN64")
+endif()
+
+# link RScore to the executable as a library
+target_link_libraries(RangeShifter PUBLIC RScore)
+
+# add RScore as an include dir
+target_include_directories(RangeShifter PUBLIC "${PROJECT_BINARY_DIR}" "${PROJECT_SOURCE_DIR}/RScore")

README.md

@@ -21,19 +21,29 @@ In Batch Mode, RangeShifter can be run from the command line (e.g., `./rangeshif
 This allows the user to run large batches of simulations with different parameters, which would need to be specified individually in the GUI version.
 The Batch Mode also enables running RangeShifter on machines with a non-interactive interface, for example a high-performance cluster.
 
-## Usage
+## Building RangeShifter
 
-The compiled software can be found in the [Software and Documentation](https://github.com/RangeShifter/RangeShifter-software-and-documentation) repo.
-RangeShifter can be built in Windows or Linux. To build the programm you need to set the operating system in the file Version.h.
+The compiled software can be found in the [Software and Documentation](https://github.com/RangeShifter/RangeShifter-software-and-documentation) repo. 
 
-For Windows: set #define LINUX_CLUSTER 0
-For Linux: set #define LINUX_CLUSTER 1
+Building RangeShifter from the source code requires CMake. If you haven't done so yet, you will need to [download and install it](https://cmake.org/download/).
 
-Then, one can build RangeShifter e.g. with the GNU compiler:
+RangeShifter can then be configured and built (out-of-source) from `CMakeLists.txt`, with the usual CMake commands:
 
 ```bash
-g++ -o rs.exe ./src/*.cpp ./src/RScore/*.cpp
+mkdir build && cd build
+cmake ..
+cmake --build .
 ```
+If you use Visual Studio as your IDE, CMake should be recognised automatically when `RangeShifter_batch_dev` is opened as a new folder. 
+Visual Studio will take care of the configuration, and you only need to select target RangeShifter.exe before pressing the build button.
+
+Alternatively, RangeShifter can also be built directly with the GNU C++ compiler, in which case some #define macros must be passed to it:
+
+```bash
+g++ -o RangeShifter.exe ./src/*.cpp ./src/RScore/*.cpp -DRSDEBUG -DRSWIN64 -DLINUX_CLUSTER
+```
+
+## Running RangeShifter
 
 For instructions on how to setup the project directory and input files, please refer to section 3.3 of the [User Manual](https://raw.githubusercontent.com/RangeShifter/RangeShifter-software-and-documentation/master/RangeShifter_v2.0_UserManual.pdf), and to the [documentation repository](https://github.com/RangeShifter/RangeShifter-software-and-documentation) for examples.