summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMike Brady <mikebrady@eircom.net>2017-09-05 17:32:19 +0100
committerMike Brady <mikebrady@eircom.net>2017-09-05 17:32:19 +0100
commit46bcb0279743970cf76d2c0b5f16b83fa80b44a9 (patch)
tree8e64475720a9b3a0f8d0223fdc7742793358f17e /README.md
parent14d47c6f129d53c1e883fb61e1a019d74cc58a16 (diff)
Move 3.2d5 to 3.1.2
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 32 insertions, 12 deletions
diff --git a/README.md b/README.md
index 36efcda..7a5b3aa 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,12 @@
Shairport Sync
=============
-Shairport Sync is an AirPlay audio player – it plays audio streamed from iTunes, iOS and macOS devices and other AirPlay sources such as Quicktime Player and [ForkedDaapd](http://ejurgensen.github.io/forked-daapd/), among others.
+Shairport Sync is an AirPlay audio player – it plays audio streamed from iTunes, iOS and macOS devices and AirPlay sources such as Quicktime Player and [ForkedDaapd](http://ejurgensen.github.io/forked-daapd/), among others.
+
Audio played by a Shairport Sync-powered device stays synchronised with the source and hence with similar devices playing the same source. In this way, synchronised multi-room audio is possible for suitable players. (Hence the name Shairport Sync, BTW.)
Shairport Sync runs on Linux and FreeBSD. It does not support AirPlay video or photo streaming.
-This is the unstable "development" branch. Changes and updates are incorporated into this branch quickly. To access the stable version, where changes are made after due time, please switch to the "master" branch.
+This is the stable "master" branch. Changes and updates are incorporated into this branch relatively slowly. To access the development version, where all the latest changes are made first, please switch to the "development" branch.
More Information
----------
@@ -59,17 +60,37 @@ In addition, Shairport Sync can output to standard output, pipes, `soundio` and
For information about changes and updates, please refer to the RELEASENOTES.md file in the distribution.
-Building And Installing the Development Version
+Building And Installing
---------------------
-The following procedures will build and install the `shairport-sync` application into your system.
+Shairport Sync may already be available as a package in your Linux distribution (search for `shairport-sync` – the package named `shairport` is a different program). Packages are available on recent versions of Debian, Ubuntu, Arch, OpenWrt and possibly more:
+
+**Ubuntu:** A `shairport-sync` installer package is available for Ubuntu. Additionally, a Personal Package Archives for Shairport Sync master and development branches are available at https://launchpad.net/~dantheperson.
+
+**Debian:** shairport-sync is in the Debian archive.
+
+**OpenWrt:** There is a Shairport Sync package in OpenWrt trunk. Also, there's an OpenWrt package at https://github.com/mikebrady/shairport-sync-for-openwrt, including one that builds back to Barrier Breaker.
+
+**Arch Linux:** Shairport Sync is available for x86_64 and i686 platforms in the Arch Linux Community Repository -- search for `shairport-sync`. See also https://www.archlinux.org/packages/.
+An Arch Linux installation package, suitable for compilation on any platform, is also available at [EliaCereda/shairport-sync-PKGBUILD](https://github.com/EliaCereda/shairport-sync-PKGBUILD).
+
+**Mac OS X:** A HomeBrew package exists for Shairport Sync. With HomeBrew installed, Shairport Sync can be installed using the command:
+```
+$brew install shairport-sync
+```
+Note that the installation uses the libao library and so synchronisation is not available — playback glitches will occur occasionally, when the ao system's buffers overflow or underflow.
+
+**Fedora:** Please see the guide at [FEDORA.md](https://github.com/mikebrady/shairport-sync/blob/master/FEDORA.md).
+
+**Cygwin:** Please see the guide at [CYGWIN.md](https://github.com/mikebrady/shairport-sync/blob/master/CYGWIN.md).
+
+Sincere thanks to all package contributors!
+
+If you wish to build and install the latest version of Shairport Sync on Debian, Ubuntu, Fedora or Arch platforms, please follow the General Build Instructions. When the program has been installed, refer to the section on Configuring Shairport Sync that follows. To build Shairport Sync from sources on FreeBSD please refer to [FREEBSD.md](https://github.com/mikebrady/shairport-sync/blob/master/FREEBSD.md).
**Remove Old Versions Of Shairport Sync**
You should check to see if `shairport-sync` is already installed – you can use the command `$ which shairport-sync` to find where it is located, if installed. If it is installed you should delete it – you may need superuser privileges. After deleting, check again in case further copies are installed elsewhere.
-**FreeBSD**
-
-To build Shairport Sync from sources on FreeBSD please refer to [FREEBSD.md](https://github.com/mikebrady/shairport-sync/blob/master/FREEBSD.md).
**Determine The Configuration Needed**
@@ -144,7 +165,6 @@ $ git clone https://github.com/mikebrady/shairport-sync.git
Next, `cd` into the shairport-sync directory and execute the following commands:
```
-$ git checkout development
$ autoreconf -i -f
```
(Note that the `autoreconf...` step may take some time on less powerful machines.)
@@ -253,19 +273,19 @@ The user and group `shairport-sync` will be created if necessary, and a runtime
If you have chosen the `--with-systemd` configuration option, then, to enable Shairport Sync to start automatically at system startup, enter:
```
-$sudo systemctl enable shairport-sync
+$ sudo systemctl enable shairport-sync
```
**Complete installation into a System V system**
If you have chosen the `--with-systemv` configuration option, enter:
```
-$sudo update-rc.d shairport-sync defaults 90 10
+$ sudo update-rc.d shairport-sync defaults 90 10
```
**Man Page**
-You can view the man page here: http://htmlpreview.github.io/?https://github.com/mikebrady/shairport-sync/blob/development/man/shairport-sync.html
+You can view the man page here: http://htmlpreview.github.io/?https://github.com/mikebrady/shairport-sync/blob/master/man/shairport-sync.html
Configuring Shairport Sync
--------
@@ -342,7 +362,7 @@ Another setting to consider is the `general` `drift_tolerance_in_seconds` settin
*Command Line Arguments*
-As previously mentioned, you can use command line arguments to provide settings to Shairport Sync as before, though newer settings will only be available via the configuration file. For full information, please read the Shairport Sync `man` page, also available at http://htmlpreview.github.io/?https://github.com/mikebrady/shairport-sync/blob/development/man/shairport-sync.html.
+As previously mentioned, you can use command line arguments to provide settings to Shairport Sync as before, though newer settings will only be available via the configuration file. For full information, please read the Shairport Sync `man` page, also available at http://htmlpreview.github.io/?https://github.com/mikebrady/shairport-sync/blob/master/man/shairport-sync.html.
Apart from the following options, all command line options can be replaced by settings in the configuration file. Here is a brief description of command line options that are not replicated by settings in the settings file.