morgan/UxPlay
1
0
Fork 0
mirror of https://github.com/morgan9e/UxPlay synced 2026-04-14 00:04:13 +09:00
Code Issues Packages Projects Releases Wiki Activity

edits to README

Browse Source
This commit is contained in:
fduncanh
2022-03-12 05:15:12 -05:00
parent 41f5356e5f
commit c4ede2fe1a
3 changed files with 21 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.html
View File

@@ -32,7 +32,7 @@
<h2 id="building-uxplay-on-linux-or-bsd">Building UxPlay on Linux (or *BSD):</h2>
<p>(Instructions for Debian/Ubuntu; adapt these for other Linuxes; for macOS, see below). See <a href="#troubleshooting">Troubleshooting</a> below for help with any difficulties.</p>
<p>Make sure that your distribution provides OpenSSL 1.1.1 or later, and libplist 2.0 or later. (This means Debian 10 “Buster”, Ubuntu 18.04 or later.) If it does not, you may need to build and install these from source (see below).</p>
<p>You need a C/C++ compiler (e.g. g++) with the standard development libraries installed. Make sure that cmake&gt;=3.4.1 and pkg-config are also installed: “sudo apt-get install cmake pkg-config”. In a terminal window, change directories to the source directory of the downloaded source code (“UxPlay-*”, “*” = “master” or the release tag for zipfile downloads, “UxPlay” for “git clone” downloads), then do</p>
<p>You need a C/C++ compiler (e.g. g++) with the standard development libraries installed. Debian-based systems provide a package “build-essential” for use in compiling software. Make sure that cmake&gt;=3.4.1 and pkg-config are also installed: “sudo apt-get install cmake pkg-config”. In a terminal window, change directories to the source directory of the downloaded source code (“UxPlay-*”, “*” = “master” or the release tag for zipfile downloads, “UxPlay” for “git clone” downloads), then do</p>
<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>
@@ -41,7 +41,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).</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), 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: “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>

10
README.md
View File

@@ -120,8 +120,9 @@ Make sure that your distribution provides OpenSSL 1.1.1 or later, and libplist 2
(This means Debian 10 "Buster", Ubuntu 18.04 or later.) If it does not, you may
need to build and install these from source (see below).
You need a C/C++ compiler (e.g. g++) with the standard development libraries installed.
Make sure that cmake>=3.4.1 and pkg-config are also installed: "sudo apt-get install cmake pkg-config".
You need a C/C++ compiler (e.g. g++) with the standard development libraries installed. Debian-based
systems provide a package "build-essential" for use in compiling software. Make sure that cmake>=3.4.1
and pkg-config are also installed: "sudo apt-get install cmake pkg-config".
In a terminal window, change directories to the source directory of the
downloaded source code ("UxPlay-\*", "\*" = "master" or the release tag for zipfile downloads, "UxPlay" for "git clone" downloads), then do
@@ -137,8 +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), 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: "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_.

23
README.txt
View File

@@ -161,11 +161,13 @@ later.) If it does not, you may need to build and install these from
source (see below).
You need a C/C++ compiler (e.g. g++) with the standard development
libraries installed. Make sure that cmake\>=3.4.1 and pkg-config are
also installed: "sudo apt-get install cmake pkg-config". In a terminal
window, change directories to the source directory of the downloaded
source code ("UxPlay-\*", "\*" = "master" or the release tag for zipfile
downloads, "UxPlay" for "git clone" downloads), then do
libraries installed. Debian-based systems provide a package
"build-essential" for use in compiling software. Make sure that
cmake\>=3.4.1 and pkg-config are also installed: "sudo apt-get install
cmake pkg-config". In a terminal window, change directories to the
source directory of the downloaded source code ("UxPlay-\*", "\*" =
"master" or the release tag for zipfile downloads, "UxPlay" for "git
clone" downloads), then do
**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
@@ -186,11 +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), 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: "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*