]> git.ipfire.org Git - thirdparty/shairport-sync.git/commitdiff
Update FREEBSD.md
authorMike Brady <4265913+mikebrady@users.noreply.github.com>
Fri, 1 Jul 2022 10:18:38 +0000 (11:18 +0100)
committerGitHub <noreply@github.com>
Fri, 1 Jul 2022 10:18:38 +0000 (11:18 +0100)
FREEBSD.md

index e25fc810b373e8acedb7eef5b59beb54de669fad..5ebc3b22cd6aa01e328447c2af286a54bbccba64 100644 (file)
@@ -1,12 +1,12 @@
 Shairport Sync on FreeBSD
 ----
-Shairport Sync runs natively on FreeBSD using the `sndio` back end, thanks to the work of [Tobias Kortkamp (t6)](https://github.com/t6).
+This guide, for a recent FreeBSD system, is to build Shairport Sync to output to the [`sndio`](https://sndio.org) and/or the [ALSA](https://www.alsa-project.org/wiki/Main_Page) sound systems.
 
-[`sndio`](http://www.sndio.org) is *"a small audio and MIDI framework part of the OpenBSD project and ported to FreeBSD, Linux and NetBSD"* developed by Alexandre Ratchov (see also [this paper](http://www.openbsd.org/papers/asiabsdcon2010_sndio.pdf) for more details).
+The `sndio` back end is based on the work of [Tobias Kortkamp (t6)](https://github.com/t6).
 
-The build instructions here build Shairport Sync to output to the `sndio` and/or the `ALSA` sound systems. `ALSA` is the [Advanced Linux Sound Architecture](https://www.alsa-project.org/wiki/Main_Page), so it is not "native" to FreeBSD, but it has been ported to some architectures under FreeBSD. 
+ALSA is not "native" to FreeBSD, but it has been ported to some architectures.
 
-Build instructions are different from previous versions of Shairport Sync and may change further. For now, leave the settings in the configuration file at default except as noted below.
+Shairport Sync can be built as an AirPlay 2 player (with [some limitations](https://github.com/mikebrady/shairport-sync/blob/development/AIRPLAY2.md#features-and-limitations)) or as "Classic" Shairport Sync – a player for the older, but still supported, AirPlay (aka "AirPlay 1") protocol.
 
 Overall, you'll be building and installing two programs. The first one is NQPTP, a companion app that Shairport Sync uses for AirPlay 2 timing, and the second one is Shairport Sync itself. Build and install NQPTP first. If you are building Classic Shairport Sync, NQPTP is unnecessary and can be omitted.