Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
chris-hld committed Jun 2, 2023
1 parent e1d943e commit b99bf74
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,20 @@ Pre-compiled binaries for Windows currently include:
`ssr-binaural.exe`, `ssr-brs.exe`, `ssr-vbap.exe`, `ssr-wfs.exe`, `ssr-aap.exe`, `ssr-dca.exe` and `ssr-generic.exe`.

They should run on all x86-64 CPUs.
So far, only the Razor and Polhemus head-tracker are ported (and I can only test the recent Razor).


Getting started
---------------
* Install Jack Audio for Windows (64bit) from [Jack Audio Downloads](http://www.jackaudio.org/downloads/).
* Get it running by following the [Installation and Configuration](http://jackaudio.org/faq/jack_on_windows.html).
Hint: If you plan on using other (ASIO) Audio-software with Jack Audio, don't forget to register the 64-bit JackRouter.
* Download and extract the latest [Release](https://github.com/chris-hld/ssr/releases).
It contains everything you need, including the cross-compiled executables.
* Adapt the configuration file `ssr.conf.windows` to your needs. Replace the paths (`Z:\SSR`) to yours. For now, please use absolute paths.
* Download and run the latest installer [Release](https://github.com/chris-hld/ssr/releases).
* Adapt the configuration file e.g. `ssr.conf.windows` to your needs.

Running the SSR on Windows
--------------------------
* Have a look at the [Documentation](http://ssr.readthedocs.io/en/latest/operation.html#running-the-ssr)
* First, start the Jack Audio Server, e.g. with `qjackctl.exe`.
* Start the SSR. There is a simple example script `start-ssr.cmd`.
* Start the SSR. Navigate a terminal to your installation folder and start from the terminal.
* Optional: Start your ASIO playback Software.
* Connect everything using Jack Audio Connection.

Expand All @@ -39,7 +36,7 @@ This could look like this:

This is the source distribution of SoundScape Renderer (SSR) licensed under the
GPLv3+. Please consult the file COPYING for more information about this license.

The user manual in the doc/ directory contains relevant informations about the
SSR, including installation instructions. Additional (very detailed)
installation instructions can be found in the file INSTALL.
Expand All @@ -48,13 +45,13 @@ For questions, bug reports and feature requests:

Contact: ssr@spatialaudio.net
Website: http://spatialaudio.net/ssr/
Documentation: http://ssr.readthedocs.io/en/latest/
Documentation: https://ssr.readthedocs.io/

Copyright (c) 2016-2018 Division of Applied Acoustics
Chalmers University of Technology
Copyright (c) 2012-2014 Institut für Nachrichtentechnik, Universität Rostock

Copyright (c) 2012-2021 Institut für Nachrichtentechnik, Universität Rostock

Copyright (c) 2006-2012 Quality & Usability Lab
Deutsche Telekom Laboratories, TU Berlin
Deutsche Telekom Laboratories, TU Berlin

0 comments on commit b99bf74

Please sign in to comment.