Skip to content

Commit

Permalink
Docs: small fixups to top-level README.md
Browse files Browse the repository at this point in the history
- was saying that the "most common use case is to stream recorded data and then record it"
- fixed dead link to Support section (now Getting Help)
- fixed link to Tutorials to point at first tutorial (was pointing to a redirect page)
- generalized wording about using stim presentation software a little bit (not every LSL user is using stim presentation SW)
  • Loading branch information
chkothe authored Mar 25, 2020
1 parent 2d30dd0 commit 57030c7
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ The most up-to-date version of this document can always be found in the
`online documentation <https://labstreaminglayer.readthedocs.io/info/getting_started.html>`_.

The most common way to use LSL is to use one or more applications with integrated LSL functionality
to stream recorded data to the local network and record the data alongside event markers from
your stimulus presentation package with the LabRecorder.
to stream data over the local network and record the data alongside any event markers (e.g., from
your stimulus presentation package) with the LabRecorder.

* Take a look at the list of
`supported devices <https://labstreaminglayer.readthedocs.io/info/supported_devices.html>`_
and follow the instructions to start streaming data from your device.
If your device is not in the list then see the Support_ section below.
If your device is not in the list then see the `Getting Help <https://github.com/sccn/labstreaminglayer#getting-help>`_ section below.
* Download `LabRecorder <https://github.com/labstreaminglayer/App-LabRecorder>`_
from its `release page <https://github.com/labstreaminglayer/App-LabRecorder/releases>`_.
(Note that LabRecorder saves data to
`Extensible Data Format (xdf) <https://github.com/sccn/xdf>`_
which has its own set of tools for loading data after finishing recording.)
* Go through the Tutorials, currently residing in the `Wiki <https://github.com/sccn/labstreaminglayer/wiki>`_.
* Go through the `Tutorials <https://github.com/sccn/labstreaminglayer/wiki/Tutorial-1.-Getting-started-with-LSL-single-stream>`_.
* Use LSL from your scientific computing environment. LSL has many language interfaces,
including Python and Matlab.

Expand Down

0 comments on commit 57030c7

Please sign in to comment.