More updates

Author: cboulay

.github/workflows/cppcmake.yml

@@ -29,10 +29,8 @@ jobs:
         config:
         - name: "ubuntu-20.04"
           os: "ubuntu-20.04"
-          qt_ver: "6.1.0"
         - name: "ubuntu-18.04"
           os: "ubuntu-18.04"
-          qt_ver: "5.15.2"
         - name: "windows-x64"
           os: "windows-latest"
           cmake_extra: "-T v142,host=x86"
@@ -46,7 +44,10 @@ jobs:
           qt_arch: "win32_msvc2019"
           qt_ver: "5.15.2"
         - name: "macOS-latest"
-          os: "macOS-latest"
+          os: "macos-latest"
+          qt_ver: "6.1.0"
+        - name: "macOS-11"
+          os: "macos-11"
           qt_ver: "6.1.0"
     steps:
     - uses: actions/checkout@v2
@@ -65,13 +66,15 @@ jobs:
            7z x liblsl.zip -oLSL
 
     - name: Download liblsl (macOS)
-      if: matrix.config.os == 'macOS-latest'
-      run: |
-           curl -L ${LSL_RELEASE_URL}/liblsl-${LSL_RELEASE}-OSX_amd64.tar.bz2 -o liblsl.tar.bz2
-           mkdir LSL
-           tar -xvf liblsl.tar.bz2 -C LSL
+      if: startsWith(matrix.config.os, 'macos-')
+      run: brew install labstreaminglayer/tap/lsl
+
+    - name: Install Qt .deb packages
+      if: startsWith(matrix.config.os, 'ubuntu-')
+      run: sudo apt install -y qtbase5-dev
 
-    - name: Install Qt
+    - name: Install Qt (Win and Mac)
+      if: startsWith(matrix.config.os, 'windows') || startsWith(matrix.config.os, 'macos')
       uses: jurplel/install-qt-action@v2.12.2
       with:
          version: ${{ matrix.config.qt_ver }}
@@ -94,7 +97,7 @@ jobs:
 
     - name: package
       run: |
-           export LD_LIBRARY_PATH=$Qt5_Dir/lib:$Qt6_Dir/lib:$LD_LIBRARY_PATH
+           export LD_LIBRARY_PATH=$Qt5_DIR/lib:$Qt6_DIR/lib:$LD_LIBRARY_PATH
            cmake --build build --config Release -j --target package
            cmake -E remove_directory package/_CPack_Packages
 

CMakeLists.txt

@@ -40,11 +40,13 @@ set(CMAKE_AUTORCC ON)
 set(CMAKE_AUTOUIC ON)
 find_package(Qt6 COMPONENTS Core Widgets Network DBus)
 if(NOT Qt6_FOUND)
-	# Require 5.15 so we can use version-agnostic linking.
-	find_package(Qt5 5.15 COMPONENTS Core Widgets Network DBus REQUIRED)
+	# If we require 5.15 then we can use version-agnostic linking, but 5.15 not easily available on Ubuntu.
+	find_package(Qt5 COMPONENTS Core Widgets Network DBus REQUIRED)
 	add_executable(${PROJECT_NAME} MACOSX_BUNDLE)
+    set(LSLAPP_QT_VER Qt5)
 else()
 	qt_add_executable(${PROJECT_NAME} MACOSX_BUNDLE MANUAL_FINALIZATION)
+    set(LSLAPP_QT_VER Qt)
 endif()
 
 ## Threads
@@ -75,9 +77,9 @@ add_executable(LabRecorderCLI MACOSX_BUNDLE
 target_link_libraries(${PROJECT_NAME}
 	PRIVATE
 	xdfwriter
-	Qt::Widgets
-	Qt::Network
-	Qt::DBus
+	${LSLAPP_QT_VER}::Widgets
+	${LSLAPP_QT_VER}::Network
+	${LSLAPP_QT_VER}::DBus
 	Threads::Threads
 	LSL::lsl
 )
@@ -130,3 +132,4 @@ endif()
 
 set(CPACK_DEBIAN_LABRECORDER_PACKAGE_SECTION "science" CACHE INTERNAL "")
 LSLGenerateCPackConfig()
+

README.md

@@ -5,16 +5,41 @@
 
 The LabRecorder is the default recording program that comes with LSL. It allows to record all streams on the lab network (or a subset) into a single file, with time synchronization between streams.
 
-[Download it from the Releases page](https://github.com/labstreaminglayer/App-LabRecorder/releases).
-
 # File Format
 
 The file format used by the LabRecorder is XDF. This is an open general-purpose format that was designed concurrently with LSL and supports all features of LSL streams. The project page is [here](https://github.com/sccn/xdf). There are importers for MATLAB, EEGLAB, BCILAB, Python, and MoBILAB.
 
 # Getting LabRecorder
 
+## Dependencies
+
+For LabRecorder to work on your system, you might need to first install some dependencies.
+
+### MacOS
+
+In the near future it will be necessary to use [homebrew](https://brew.sh/) to manage LSL Apps and their dependencies:
+* Install homebrew: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
+* Install liblsl: `brew install labstreaminglayer/tap/lsl`
+* Install Qt6: `brew install qt`
+
+### Linux Ubuntu
+
+The Ubuntu releases do not typically ship with their dependencies so you will also have to download and install those:
+* Download and install the latest [liblsl-{version}-bionic_amd64.deb from its release page](https://github.com/sccn/liblsl/releases)
+    * We hope to make this available via a package manager soon.
+    * You can install liblsl directly by double clicking on it, or with with `sudo dpkg -i {filename}.deb`
+* See the bottom of the [lsl build env docs](https://labstreaminglayer.readthedocs.io/dev/build_env.html).
+    * For most cases, this will amount to `sudo apt-get install qtbase5-dev`
+
+## Downloading LabRecorder
+
+### MacOS
+
+* `brew install labrecorder`
+
+### Others
+
 Navigate to the [`releases` page](https://github.com/labstreaminglayer/App-LabRecorder/releases) and download the latest release for your platform.
-The Ubuntu releases do not typically ship with the libsl dependencies so you will also have to download and install [liblsl from its release page](https://github.com/sccn/liblsl/releases).
 
 # Usage