Update build docs for FLAC support

sumater · Dec 7, 2022 · 8cd8d3d · 8cd8d3d
1 parent e86df4f
commit 8cd8d3d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/docs/building_on_linux.md b/docs/building_on_linux.md
@@ -12,16 +12,18 @@ On Ubuntu, run:
 
     sudo apt update
 	sudo apt install build-essential automake autoconf-archive libsdl2-dev \
-	                 git libtool
+	                 git libtool libflac-dev
 
 On Arch Linux:
 
 	sudo pacman -Syu
-	sudo pacman -S base-devel git sdl2 alsa-lib libxv libxxf86vm
+	sudo pacman -S base-devel git sdl2 alsa-lib libxv libxxf86vm flac
 
 Git is not strictly required, but if you don't need it you'll need to download
 a tarball manually, and your build won't have a proper version string.
 
+FLAC libraries are optional and only used for FLAC sample loading support.
+
 On other distros, the package names may be different. In particular, note that
 `build-essential` includes the packages `gcc` and `make` on Debian-based
 systems.

diff --git a/docs/building_on_osx.md b/docs/building_on_osx.md
@@ -15,6 +15,9 @@ instead:
 
     sudo port install automake autoconf libtool libsdl2 git
 
+For FLAC sample loading support, you will also need development versions of the
+`flac` and `libogg` libraries.
+
 In this case, you may have to open a new terminal shell, or else you may get
 warnings about the version of autoconf/automake you're using.
 

diff --git a/docs/building_on_windows.md b/docs/building_on_windows.md
@@ -54,6 +54,10 @@ If asked to "enter a selection", hit Enter to go with the default.
 Also, you need the following specific dependency:
 
 	pacman -S mingw-w64-x86_64-SDL2
+
+For FLAC sample loading, you'll also need the following dependency:
+
+	pacman -S mingw-w64-x86_64-flac
 
 Once you have installed these packages, close all your MSYS2 windows 
 before continuing with the instructions.