edit README

This commit is contained in:
fduncanh
2022-05-06 12:53:27 -04:00
parent ce2fe373d6
commit 7377d2c742
3 changed files with 6 additions and 5 deletions

View File

@@ -42,7 +42,7 @@
<li><code>cmake .</code> (or “<code>cmake -DZOOMFIX=ON .</code>” to get a screen-sharing fix to make X11 mirror display windows visible to screen-sharing applications such as Zoom, see <a href="#improvements">Improvements</a> #3 below). <strong>ZOOMFIX is only needed for GStreamer-1.18.x or earlier</strong>.</li>
<li><code>make</code></li>
<li><code>sudo make install</code> (you can afterwards uninstall with <code>sudo make uninstall</code> in the same directory in which this was run)</li>
<li>Install GStreamer plugins that you need: <code>sudo apt-get install gstreamer1.0-&lt;plugin&gt;</code>; values of <code>&lt;plugin&gt;</code> needed are: “<strong>plugins-base</strong>”, “<strong>libav</strong>” (for sound), “<strong>plugins-good</strong>” (for v4l2 hardware h264 decoding) and “<strong>plugins-bad</strong>” (for h264 decoding). Also needed may be “<strong>gl</strong>” for OpenGL support (which may be useful, and should be used with h264 decoding by the NVIDIA GPU), and “<strong>x</strong>” for X11 support, although these may already be installed; “<strong>vaapi</strong>” is needed for hardware-accelerated h264 video decoding by Intel graphics (not for NVIDIA). Also install “<strong>tools</strong>” to get the utility gst-inspect-1.0 for examining the GStreamer installation.</li>
<li>Install GStreamer plugins that you need: <code>sudo apt-get install gstreamer1.0-&lt;plugin&gt;</code>; values of <code>&lt;plugin&gt;</code> needed are: “<strong>plugins-base</strong>”, “<strong>libav</strong>” (for sound), “<strong>plugins-good</strong>” (for v4l2 hardware h264 decoding) and “<strong>plugins-bad</strong>” (for h264 decoding). Also needed may be “<strong>gl</strong>” for OpenGL support (which may be useful, and should be used with h264 decoding by the NVIDIA GPU), and “<strong>x</strong>” for X11 support, although these may already be installed; “<strong>vaapi</strong>” is needed for hardware-accelerated h264 video decoding by Intel or AMD graphics (but not for use with NVIDIA using proprietary drivers). Also install “<strong>tools</strong>” to get the utility gst-inspect-1.0 for examining the GStreamer installation.</li>
</ol>
<p><em>If you intend to modify the code, use a separate “build” directory: replace</em><code>cmake [ ] .</code><em>by</em><code>mkdir build ; cd build ; cmake [ ] ..</code>”; <em>you can then clean the build directory with</em><code>rm -rf build/*</code><em>(run from within the UxPlay source directory) without affecting the source directories which contain your modifications</em>.</p>
<p>The above script installs the executable file “<code>uxplay</code>” to <code>/usr/local/bin</code>, (and installs a manpage to somewhere like <code>/usr/local/share/man/man1</code> and README files to somewhere like <code>/usr/local/share/doc/uxplay</code>). It can also be found in the build directory after the build processs.</p>

View File

@@ -159,7 +159,7 @@ for GStreamer-1.18.x or earlier**.
`<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).
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

View File

@@ -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*