Skip to content

Commit

Permalink
Update README.md to explain desktop build process
Browse files Browse the repository at this point in the history
Also documents the -vr and -ar options.
  • Loading branch information
dougg3 authored and FD- committed Sep 4, 2020
1 parent 7102272 commit 4539a7d
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,16 +56,16 @@ make

GCC 5 or later is required.

# Experimental: Building for gstreamer (works on generic Linux machines)
# Building on desktop Linux:

For building on Ubuntu 18.04, follow these steps:
For building on Ubuntu 18.04 or 20.04, follow these steps:
```bash
sudo apt-get install cmake libavahi-compat-libdnssd-dev libplist-dev libssl-dev \
libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-libav \
gstreamer1.0-vaapi gstreamer1.0-plugins-bad
mkdir build
cd build
cmake .. -DRENDERER=gstreamer
cmake ..
make
```

Expand All @@ -86,6 +86,10 @@ At the moment, these options are implemented:

**-a (hdmi|analog|off)**: Set audio output device

**-vr renderer**: Select a video renderer to use (rpi, gstreamer, or dummy)

**-ar renderer**: Select an audio renderer to use (rpi, gstreamer, or dummy)

**-d**: Enables debug logging. Will lead to choppy playback due to heavy console output.

**-v/-h**: Displays short help and version information.
Expand Down

0 comments on commit 4539a7d

Please sign in to comment.