From cdea9727d13be9afb1c0503b8547f67e635e9040 Mon Sep 17 00:00:00 2001 From: fduncanh Date: Sat, 12 Mar 2022 05:23:07 -0500 Subject: [PATCH] edit README --- README.html | 4 ++-- README.md | 8 ++++---- README.txt | 14 +++++++------- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.html b/README.html index c4fd512..1913f72 100644 --- a/README.html +++ b/README.html @@ -36,12 +36,12 @@

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. -
  2. sudo apt-get install libavahi-compat-libdnssd-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-libav gstreamer1.0-plugins-bad.
    3. +
  3. sudo apt-get install libavahi-compat-libdnssd-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev.
  4. sudo apt-get install libx11-dev (only needed if you invoke the “ZOOMFIX” X11 display-name fix in the next step)
  5. 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).
  6. make
  7. sudo make install (you can afterwards uninstall with sudo make uninstall in the same directory in which this was run)
    8. -
  8. 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).
    9. +
  9. Install GStreamer plugins that you need: sudo apt-get install gstreamer1.0-<plugin>; values of <plugin> needed are: “plugins-base”, “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 9141d5d..0e8bb95 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,7 @@ downloaded source code ("UxPlay-\*", "\*" = "master" or the release tag for zipf 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. `sudo apt-get install libavahi-compat-libdnssd-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-libav gstreamer1.0-plugins-bad`. +2. `sudo apt-get install libavahi-compat-libdnssd-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev`. 3. `sudo apt-get install libx11-dev` (only needed if you invoke the "ZOOMFIX" X11 display-name fix in the next step) 4. `cmake .` (or "`cmake -DZOOMFIX=ON .`" to get a screen-sharing fix to make X11 mirror display windows visible to screen-sharing applications such as @@ -138,9 +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), "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). + `` needed are: "plugins-base", "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 0c905f4..760869e 100644 --- a/README.txt +++ b/README.txt @@ -176,7 +176,7 @@ packaging for a distribution, use the cmake option 1. `sudo apt-get install libssl-dev libplist-dev` (unless you need to build OpenSSL and libplist from source). -2. `sudo apt-get install libavahi-compat-libdnssd-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-libav gstreamer1.0-plugins-bad`. +2. `sudo apt-get install libavahi-compat-libdnssd-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev`. 3. `sudo apt-get install libx11-dev` (only needed if you invoke the "ZOOMFIX" X11 display-name fix in the next step) 4. `cmake .` (or "`cmake -DZOOMFIX=ON .`" to get a screen-sharing fix @@ -188,12 +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), "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). + needed are: "plugins-base", "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*