From 7377d2c74268296616f65c0fc31c91be35884283 Mon Sep 17 00:00:00 2001 From: fduncanh Date: Fri, 6 May 2022 12:53:27 -0400 Subject: [PATCH] edit README --- README.html | 2 +- README.md | 2 +- README.txt | 7 ++++--- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.html b/README.html index 75d289d..eae8d41 100644 --- a/README.html +++ b/README.html @@ -42,7 +42,7 @@
  • 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). ZOOMFIX is only needed for GStreamer-1.18.x or earlier.
  • make
  • sudo make install (you can afterwards uninstall with sudo make uninstall in the same directory in which this was run)
    • -
  • 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 h264 decoding). Also needed may be “gl” for OpenGL support (which may be useful, and should be used with h264 decoding by the NVIDIA GPU), 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). Also install “tools” to get the utility gst-inspect-1.0 for examining the GStreamer installation.
    • +
  • 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 h264 decoding). Also needed may be “gl” for OpenGL support (which may be useful, and should be used with h264 decoding by the NVIDIA GPU), and “x” for X11 support, although these may already be installed; “vaapi” is needed for hardware-accelerated h264 video decoding by Intel or AMD graphics (but not for use with NVIDIA using proprietary drivers). Also install “tools” to get the utility gst-inspect-1.0 for examining the GStreamer installation.

    • 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 7347a2a..a61f437 100644 --- a/README.md +++ b/README.md @@ -159,7 +159,7 @@ for GStreamer-1.18.x or earlier**. `` needed are: "**plugins-base**", "**libav**" (for sound), "**plugins-good**" (for v4l2 hardware h264 decoding) and "**plugins-bad**" (for h264 decoding). Also needed may be "**gl**" for OpenGL support (which may be useful, and should be used with h264 decoding by the NVIDIA GPU), 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). + is needed for hardware-accelerated h264 video decoding by Intel or AMD graphics (but not for use with NVIDIA using proprietary drivers). Also install "**tools**" to get the utility gst-inspect-1.0 for examining the GStreamer installation. _If you intend to modify the code, use a separate "build" directory: replace_ "```cmake [ ] . ```" _by_ "```mkdir build ; cd build ; cmake [ ] ..```"; _you can then clean diff --git a/README.txt b/README.txt index fcdd3f7..47e8671 100644 --- a/README.txt +++ b/README.txt @@ -209,9 +209,10 @@ packaging for a distribution, use the cmake option for OpenGL support (which may be useful, and should be used with h264 decoding by the NVIDIA GPU), 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). Also install "**tools**" to get the utility gst-inspect-1.0 - for examining the GStreamer installation. + hardware-accelerated h264 video decoding by Intel or AMD graphics + (but not for use with NVIDIA using proprietary drivers). Also + install "**tools**" to get the utility gst-inspect-1.0 for examining + the GStreamer installation. *If you intend to modify the code, use a separate "build" directory: replace* "`cmake [ ] .`" *by*