From 51807d930c5e785e25f2fa459699503586ba6586 Mon Sep 17 00:00:00 2001 From: fduncanh Date: Sat, 12 Mar 2022 12:36:03 -0500 Subject: [PATCH] edit README --- README.html | 2 +- README.md | 2 ++ README.txt | 3 ++- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.html b/README.html index 1913f72..ccffd68 100644 --- a/README.html +++ b/README.html @@ -41,7 +41,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).
  • 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 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).
    • +
  • 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). 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 0e8bb95..b4fedb0 100644 --- a/README.md +++ b/README.md @@ -141,6 +141,8 @@ Zoom, see [Improvements](#improvements) \#3 below). `` 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). + 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_. diff --git a/README.txt b/README.txt index 760869e..d2cee9a 100644 --- a/README.txt +++ b/README.txt @@ -193,7 +193,8 @@ packaging for a distribution, use the cmake option 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). + graphics (not for NVIDIA). 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*