diff --git a/README.html b/README.html index eb00efd..c4fd512 100644 --- a/README.html +++ b/README.html @@ -32,7 +32,7 @@

Building UxPlay on Linux (or *BSD):

(Instructions for Debian/Ubuntu; adapt these for other Linuxes; for macOS, see below). See Troubleshooting below for help with any difficulties.

Make sure that your distribution provides OpenSSL 1.1.1 or later, and libplist 2.0 or later. (This means Debian 10 “Buster”, Ubuntu 18.04 or later.) If it does not, you may need to build and install these from source (see below).

-

You need a C/C++ compiler (e.g. g++) with the standard development libraries installed. Make sure that cmake>=3.4.1 and pkg-config are also installed: “sudo apt-get install cmake pkg-config”. In a terminal window, change directories to the source directory of the downloaded source code (“UxPlay-*”, “*” = “master” or the release tag for zipfile downloads, “UxPlay” for “git clone” downloads), then do

+

You need a C/C++ compiler (e.g. g++) with the standard development libraries installed. Debian-based systems provide a package “build-essential” for use in compiling software. Make sure that cmake>=3.4.1 and pkg-config are also installed: “sudo apt-get install cmake pkg-config”. In a terminal window, change directories to the source directory of the downloaded source code (“UxPlay-*”, “*” = “master” or the release tag for zipfile downloads, “UxPlay” for “git clone” downloads), then do

Note: By default UxPlay will be built with optimization for the computer it is built on; when this is not the case, as when you are packaging for a distribution, use the cmake option -DNO_MARCH_NATIVE=ON.

  1. sudo apt-get install libssl-dev libplist-dev (unless you need to build OpenSSL and libplist from source).
    2. @@ -41,7 +41,7 @@
  2. cmake . (or “cmake -DZOOMFIX=ON .” to get a screen-sharing fix to make X11 mirror display windows visible to screen-sharing applications such as Zoom, see Improvements #3 below).
  3. make
  4. sudo make install (you can afterwards uninstall with sudo make uninstall in the same directory in which this was run)
    5. -
  5. Install GStreamer plugins that you need: sudo apt-get install gstreamer1.0-<plugin>; values of <plugin> needed are: “libav” (for sound), and “plugins-bad” (for software h264 decoding). Also needed may be “gl” for OpenGL support, and “x” for X11 support, although these may already be installed; “vaapi” is needed for hardware-accelerated h264 video decoding by Intel graphics (not for NVIDIA).
    6. +
  6. Install GStreamer plugins that you need: sudo apt-get install gstreamer1.0-<plugin>; values of <plugin> needed are: “libav” (for sound), “plugins-good” (for v4l2 hardware h264 decoding) and “plugins-bad” (for software h264 decoding). Also needed may be “gl” for OpenGL support, and “x” for X11 support, although these may already be installed; “vaapi” is needed for hardware-accelerated h264 video decoding by Intel graphics (not for NVIDIA).

If you intend to modify the code, use a separate “build” directory: replace “cmake [ ] .” by “mkdir build ; cd build ; cmake [ ] ..”; you can then clean the build directory with “rm -rf build/*” (run from within the UxPlay source directory) without affecting the source directories which contain your modifications.

The above script installs the executable file “uxplay” to /usr/local/bin, (and installs a manpage to somewhere like /usr/local/share/man/man1 and README files to somewhere like /usr/local/share/doc/uxplay). It can also be found in the build directory after the build processs.

diff --git a/README.md b/README.md index e9ec087..9141d5d 100644 --- a/README.md +++ b/README.md @@ -120,8 +120,9 @@ Make sure that your distribution provides OpenSSL 1.1.1 or later, and libplist 2 (This means Debian 10 "Buster", Ubuntu 18.04 or later.) If it does not, you may need to build and install these from source (see below). -You need a C/C++ compiler (e.g. g++) with the standard development libraries installed. -Make sure that cmake>=3.4.1 and pkg-config are also installed: "sudo apt-get install cmake pkg-config". +You need a C/C++ compiler (e.g. g++) with the standard development libraries installed. Debian-based +systems provide a package "build-essential" for use in compiling software. Make sure that cmake>=3.4.1 +and pkg-config are also installed: "sudo apt-get install cmake pkg-config". In a terminal window, change directories to the source directory of the downloaded source code ("UxPlay-\*", "\*" = "master" or the release tag for zipfile downloads, "UxPlay" for "git clone" downloads), then do @@ -137,8 +138,9 @@ Zoom, see [Improvements](#improvements) \#3 below). 5. `make` 6. `sudo make install` (you can afterwards uninstall with `sudo make uninstall` in the same directory in which this was run) 7. Install GStreamer plugins that you need: `sudo apt-get install gstreamer1.0-`; values of - `` needed are: "libav" (for sound), and "plugins-bad" (for software h264 decoding). Also needed may be "gl" for OpenGL support, and "x" for X11 - support, although these may already be installed; "vaapi" is needed for hardware-accelerated h264 video decoding by Intel graphics (not for NVIDIA). + `` needed are: "libav" (for sound), "plugins-good" (for v4l2 hardware h264 decoding) and "plugins-bad" (for software h264 decoding). + Also needed may be "gl" for OpenGL support, and "x" for X11 support, although these may already be installed; "vaapi" is needed + for hardware-accelerated h264 video decoding by Intel graphics (not for NVIDIA). _If you intend to modify the code, use a separate "build" directory: replace_ "```cmake [ ] . ```" _by_ "```mkdir build ; cd build ; cmake [ ] ..```"; _you can then clean the build directory with_ "```rm -rf build/* ```" _(run from within the UxPlay source directory) without affecting the source directories which contain your modifications_. diff --git a/README.txt b/README.txt index 2c4f541..0c905f4 100644 --- a/README.txt +++ b/README.txt @@ -161,11 +161,13 @@ later.) If it does not, you may need to build and install these from source (see below). You need a C/C++ compiler (e.g. g++) with the standard development -libraries installed. Make sure that cmake\>=3.4.1 and pkg-config are -also installed: "sudo apt-get install cmake pkg-config". In a terminal -window, change directories to the source directory of the downloaded -source code ("UxPlay-\*", "\*" = "master" or the release tag for zipfile -downloads, "UxPlay" for "git clone" downloads), then do +libraries installed. Debian-based systems provide a package +"build-essential" for use in compiling software. Make sure that +cmake\>=3.4.1 and pkg-config are also installed: "sudo apt-get install +cmake pkg-config". In a terminal window, change directories to the +source directory of the downloaded source code ("UxPlay-\*", "\*" = +"master" or the release tag for zipfile downloads, "UxPlay" for "git +clone" downloads), then do **Note:** By default UxPlay will be built with optimization for the computer it is built on; when this is not the case, as when you are @@ -186,11 +188,12 @@ packaging for a distribution, use the cmake option `sudo make uninstall` in the same directory in which this was run) 7. Install GStreamer plugins that you need: `sudo apt-get install gstreamer1.0-`; values of `` - needed are: "libav" (for sound), and "plugins-bad" (for software - h264 decoding). Also needed may be "gl" for OpenGL support, and "x" - for X11 support, although these may already be installed; "vaapi" is - needed for hardware-accelerated h264 video decoding by Intel - graphics (not for NVIDIA). + needed are: "libav" (for sound), "plugins-good" (for v4l2 hardware + h264 decoding) and "plugins-bad" (for software h264 decoding). Also + needed may be "gl" for OpenGL support, and "x" for X11 support, + although these may already be installed; "vaapi" is needed for + hardware-accelerated h264 video decoding by Intel graphics (not for + NVIDIA). *If you intend to modify the code, use a separate "build" directory: replace* "`cmake [ ] .`" *by*