Skip to content

Commit fddd03d

Browse files
committed
Update build instructions.
1 parent 22222ea commit fddd03d

1 file changed

Lines changed: 26 additions & 20 deletions

File tree

README.md

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,44 +11,50 @@ The file format used by the LabRecorder is XDF. This is an open general-purpose
1111

1212
# Getting LabRecorder
1313

14-
## Dependencies
14+
The [releases page](https://github.com/labstreaminglayer/App-LabRecorder/releases) contains archives of past LabRecorder builds. Try downloading and running an archive that matches your platform.
1515

16-
For LabRecorder to work on your system, you might need to first install some dependencies.
16+
If there are no archives matching your target platform, or the ones available don't run, then continue reading below. If the instructions don't help then please post an issue to the [repo's issues page](https://github.com/labstreaminglayer/App-LabRecorder/issues).
1717

18-
### MacOS
18+
## Dependencies
1919

20-
In the near future it will be necessary to use [homebrew](https://brew.sh/) to manage LSL Apps and their dependencies:
21-
* Install homebrew: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
20+
For LabRecorder to work on your system, you might need to first install some dependencies, specifically liblsl and optionally Qt.
2221

23-
### Linux Ubuntu
22+
### Windows
2423

25-
The Ubuntu releases do not typically ship with their dependencies so you will also have to download and install those:
26-
* Download and install the latest [liblsl-{version}-bionic_amd64.deb from its release page](https://github.com/sccn/liblsl/releases)
27-
* We hope to make this available via a package manager soon.
28-
* You can install liblsl directly by double clicking on it, or with with `sudo dpkg -i {filename}.deb`
29-
* See the bottom of the [lsl build env docs](https://labstreaminglayer.readthedocs.io/dev/build_env.html).
30-
* For most cases, this will amount to `sudo apt-get install qtbase5-dev`
31-
32-
## Downloading LabRecorder
24+
The Windows archives ship with all required dependencies. If you suspect you are missing a dependency, try running [Dependencies.exe](https://github.com/lucasg/Dependencies/releases) then navigating to the LabRecorder.exe. It's important to launch Dependencies.exe from the same environment that you would use to launch this application: if you launch this application by double-clicking the executable in Windows' finder then do the same on the Dependencies.exe icon; if you launch this application in a Terminal window, then use that same Terminal to launch Dependencies.
3325

3426
### MacOS
3527

36-
* `brew install labstreaminglayer/tap/labrecorder`
28+
In the near future, many LSL Apps (especially LabRecorder) will not ship with their dependencies and will look for the dependencies to be installed on the system. The easiest way to manage the dependencies is by using [homebrew](https://brew.sh/):
29+
* Install homebrew: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
30+
* `brew install labstreaminglayer/tap/lsl`
31+
* `brew install qt`
32+
33+
You can then install LabRecorder directly from homebrew: `brew install labrecorder`
3734

38-
* Run it with `open /usr/local/opt/labrecorder/LabRecorder/LabRecorder.app`
35+
Run it with `open /usr/local/opt/labrecorder/LabRecorder/LabRecorder.app`
3936

40-
### Others
37+
### Linux Ubuntu
4138

42-
Navigate to the [`releases` page](https://github.com/labstreaminglayer/App-LabRecorder/releases) and download the latest release for your platform.
39+
The Ubuntu releases do not typically ship with their dependencies, so you must download and install those:
40+
* Download, extract, and install the latest [liblsl-{version}-{target}_amd64.deb from its release page](https://github.com/sccn/liblsl/releases)
41+
* We hope to make this available via a package manager soon.
42+
* Quick ref Ubuntu 20.04: `curl -L https://github.com/sccn/liblsl/releases/download/v1.16.0/liblsl-1.16.0-bionic_amd64.deb -o liblsl.deb`
43+
* Quick ref Ubuntu 22.04: `curl -L https://github.com/sccn/liblsl/releases/download/v1.16.0/liblsl-1.16.0-jammy_amd64.deb -o liblsl.deb`
44+
* You can install liblsl directly by double-clicking on the deb, or with `sudo dpkg -i {filename}.deb` or `sudo apt install {filename}.deb`
45+
* See the bottom of the [lsl build env docs](https://labstreaminglayer.readthedocs.io/dev/build_env.html).
46+
* For most cases, this will amount to installing Qt and its dependencies:
47+
* Ubuntu 18.xx or 20.xx: `sudo apt-get install build-essential qtbase5-dev libpugixml-dev`
48+
* Ubuntu >= 22.04: `sudo apt-get install qt6-base-dev freeglut3-dev`
4349

4450
# Usage
4551

4652
The LabRecorder displays a list of currently present device streams under "Record from Streams". If you have turned on a device after you have already started the recorder, click the "Update" button to update the list (this takes ca. 2 seconds).
47-
> For testing you can use a "dummy" device from the `lslexamples` found in the [liblsl release assets](https://github.com/sccn/liblsl/releases) (for example SendData<!--, SendStringMarkers, and SendDataSimple-->).
53+
> For testing, you can use a "dummy" device from the `lslexamples` found in the [liblsl release assets](https://github.com/sccn/liblsl/releases) (for example SendData<!--, SendStringMarkers, and SendDataSimple-->).
4854
4955
If you cannot see streams that are provided on another computer, read the section Network Troubleshooting on the NetworkConnectivity page.
5056

51-
You can select which streams you want to record from and which not by checking the check boxes next to them.
57+
You can select which streams you want to record from and which not by checking the checkboxes next to them.
5258
> ![labrecorder-default.png](doc/labrecorder-default.png)
5359
5460
Note that if you have multiple streams with the same name and host, it is impossible to check only 1. If any is checked then they will all be recorded.

0 commit comments

Comments
 (0)