Skip to content

Commit 263a00a

Browse files
committed
Update README, remove build instructions and FAQs already moved to the online documentation
1 parent c6d3dd9 commit 263a00a

File tree

4 files changed

+15
-206
lines changed

4 files changed

+15
-206
lines changed

BUILD.md

Lines changed: 0 additions & 81 deletions
This file was deleted.

FAQ.md

Lines changed: 0 additions & 96 deletions
This file was deleted.

README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,22 @@
66

77
The lab streaming layer is a simple all-in-one approach to streaming experiment
88
data between applications in a lab, e.g. instrument time series, event markers,
9-
audio, and so on. For more information, please read the online documentation:
10-
11-
https://labstreaminglayer.readthedocs.io
9+
audio, and so on. For more information, please read the
10+
[online documentation](https://labstreaminglayer.readthedocs.io)
1211

1312
## Getting and using liblsl
1413

15-
The most up-to-date instructions are in the [online documentation](https://labstreaminglayer.readthedocs.io/dev/app_dev.html).
14+
The most up-to-date instructions are in the
15+
[quick start online documentation](https://labstreaminglayer.readthedocs.io/info/getting_started.html).
1616

1717
## Building liblsl
1818

19+
Precompiled packages are uploaded
20+
21+
- to the [Release page](https://github.com/sccn/liblsl/releases)
22+
- the [Anaconda cloud](https://anaconda.org/tstenner/liblsl)
23+
1924
To compile the library yourself from source please follow the [online documentation](https://labstreaminglayer.readthedocs.io/dev/lib_dev.html).
20-
NOTE: The documentation is in the middle of migrating to this location. If it's not there yet, also check [here](https://labstreaminglayer.readthedocs.io/dev/build.html),
21-
and [Matthew's instructions here](https://github.com/sccn/liblsl/blob/master/BUILD.md).
2225

2326
For single board computers running linux, you can also try
2427
`standalone_compilation_linux.sh`.
@@ -29,21 +32,16 @@ To build language bindings (e.g. for
2932
the [corresponding directory in the main repository](https://github.com/sccn/labstreaminglayer/tree/master/LSL).
3033

3134
You might also be interested in
32-
[apps to connect recording equipment](https://labstreaminglayer.readthedocs.io/info/supported_devices.html)
33-
and the [LabRecorder](https://github.com/labstreaminglayer/App-LabRecorder).
34-
35-
Precompiled packages are uploaded
35+
[apps to connect to recording equipment](https://labstreaminglayer.readthedocs.io/info/supported_devices.html)
36+
and the [LabRecorder](https://github.com/labstreaminglayer/App-LabRecorder) to record streams to disk.
3637

37-
- to the [Release page](https://github.com/sccn/liblsl/releases)
38-
- the [Anaconda cloud](https://anaconda.org/tstenner/liblsl)
3938

4039
## Boost
4140

42-
liblsl uses boost (mainly Boost.ASIO and Boost.Thread) extensively.
43-
Because Windows has timing problems with newer Boost versions and embedding liblsl
44-
in an application that links to an other Boost version (notably Matlab) causes runtime
45-
errors, we bundle a subset of boost in
46-
`lslboost` (with patches to fix the timing behavior on Windows).
41+
liblsl uses boost (mainly Boost.ASIO) extensively.
42+
Because embedding liblsl in an application that links to an other Boost version (notably Matlab)
43+
causes runtime errors, we bundle a subset of boost in
44+
`lslboost`.
4745

4846
To update the included lslboost, install Boost bcp and use the `update_lslboost.sh` script.
4947

RELEASECHECKLIST.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)