Fix INSTALL.md (fixes #5)

.github/workflows/c-cpp.yml

@@ -12,14 +12,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Create Build File
-      run: mkdir build
-    - name: Going to Build File
-      run: cd build
-    - name: Running Cmake
-      run: cmake -DCOMPILER=clang
-    - name: make
-      run: make
-    - name: make test
-      run: make test
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - name: Configure
+      run: mkdir build && cd build && cmake ..
+    - name: Build
+      run: cmake --build build
+    - name: Run tests
+      run: cmake --build build --target test

CMakeLists.txt

@@ -1,12 +1,12 @@
-cmake_minimum_required(VERSION 2.8)
+cmake_minimum_required(VERSION 3.5)
 
 # settings
 project(ringbuffer)
 set(DESCRIPTION "a lock free, multi-reader ringbuffer lib")
 
 SET(VERSION_MAJOR "0")
-SET(VERSION_MINOR "8")
-SET(VERSION_PATCH "9")
+SET(VERSION_MINOR "9")
+SET(VERSION_PATCH "0")
 
 # options
 option(WANT_MLOCK "provide the mlock system call" ON)

INSTALL.md

@@ -19,12 +19,15 @@ In this directory, type:
 
 ```sh
 mkdir build
-cd build
-# for a release build using clang (suggested), where /path/to/zynaddsubfx is
-# the binary executable for zynaddsubfx
-cmake -DCOMPILER=clang \
-      -DCMAKE_BUILD_TYPE=Release \
-      ..
+cd $_
+cmake ..
+```
+
+The typical options for `cmake` apply, e.g.:
+
+```
+-DCMAKE_BUILD_TYPE=Release
+-DCMAKE_CXX_COMPILER=clang++
 ```
 
 # 3 Running
@@ -36,14 +39,9 @@ make test
 # 4 Realtime check with stoat
 Make sure stoat is (root-)installed on your disk.
 
-Instead of using the cmake code from above, use
-```sh
-cmake -DCOMPILER=stoat ..
-```
-
-Then, run
+For configuring, use
 ```sh
-make stoat_ringbuffer
+cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_COMPILER=/usr/local/bin/stoat-compile++ ..
 ```
 
 The output should prompt a total of 0 errors.

README.md

@@ -58,6 +58,7 @@ See tests.
 # 7 Thanks to
 
 In alphabetical order, I thank:
+  * Harshil-Jani (@Harshil-Jani)
   * Martin Pavelek (@he29-net)
   * The JACK team for their ringbuffer