Skip to content

Commit b89723b

Browse files
committed
List build dependencies on Debian in the README
1 parent dd9b143 commit b89723b

2 files changed

Lines changed: 24 additions & 9 deletions

File tree

.github/workflows/build-and-test.yaml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,9 @@ jobs:
3838
- name: Create Build Environment
3939
run: cmake -E make_directory ${{ github.workspace }}/build
4040
- name: Configure CMake
41-
working-directory: ${{ github.workspace }}/build
42-
# Note the current convention is to use the -S and -B options here to
43-
# specify source and build directories, but this is only available with
44-
# CMake 3.13 and higher. The CMake binaries on the Github Actions
45-
# machines are (as of this writing) 3.12
4641
run: >
47-
cmake $GITHUB_WORKSPACE
42+
cmake
43+
-B ${{ github.workspace }}/build
4844
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }}
4945
-DBUILD_TESTING=ON
5046
${{ matrix.audio-backend }}

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,29 @@ from the last 100 ms of captured audio.
3636

3737
## Installation
3838

39+
### Dependencies (Debian/Ubuntu)
40+
41+
```sh
42+
# Basic build tools and CMake
43+
sudo apt install build-essential cmake
44+
# Audio backends
45+
sudo apt install libasound2-dev libpipewire-0.3-dev portaudio19-dev
46+
# Output formats
47+
sudo apt install libmp3lame-dev libogg-dev libsndfile1-dev libopusenc-dev libvorbis-dev
48+
```
49+
50+
### Building
51+
3952
```sh
40-
mkdir build && cd build
41-
cmake .. \
53+
cmake -B build \
54+
-DCMAKE_BUILD_TYPE=Release \
4255
-DENABLE_ALSA=ON -DENABLE_PIPEWIRE=ON -DENABLE_PORTAUDIO=ON \
4356
-DENABLE_SNDFILE=ON -DENABLE_MP3LAME=ON -DENABLE_OPUS=ON -DENABLE_VORBIS=ON
44-
make && make install
57+
cmake --build build
58+
```
59+
60+
### Installing
61+
62+
```sh
63+
sudo cmake --install build
4564
```

0 commit comments

Comments
 (0)