edit README

This commit is contained in:
fduncanh
2022-03-12 05:23:07 -05:00
parent c4ede2fe1a
commit cdea9727d1
3 changed files with 13 additions and 13 deletions

View File

@@ -36,12 +36,12 @@
<p><strong>Note:</strong> 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 <code>-DNO_MARCH_NATIVE=ON</code>.</p>
<ol type="1">
<li><code>sudo apt-get install libssl-dev libplist-dev</code> (unless you need to build OpenSSL and libplist from source).</li>
<li><code>sudo apt-get install libavahi-compat-libdnssd-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-libav gstreamer1.0-plugins-bad</code>.</li>
<li><code>sudo apt-get install libavahi-compat-libdnssd-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev</code>.</li>
<li><code>sudo apt-get install libx11-dev</code> (only needed if you invoke the “ZOOMFIX” X11 display-name fix in the next step)</li>
<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).</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: “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).</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: “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).</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

@@ -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-<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).
`<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_.

View File

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