From 271bd30e52b5cf481506ab347f77f3e06f28c854 Mon Sep 17 00:00:00 2001 From: "F. Duncanh" Date: Mon, 5 Jun 2023 06:55:34 -0400 Subject: [PATCH] README updates --- README.html | 16 +++++++++++++--- README.md | 12 +++++++++--- README.txt | 15 ++++++++++++--- 3 files changed, 34 insertions(+), 9 deletions(-) diff --git a/README.html b/README.html index f8e5fd9..e0978b7 100644 --- a/README.html +++ b/README.html @@ -481,7 +481,7 @@ synchronized.

  • For best performance, the Raspberry Pi needs the GStreamer Video4linux2 plugin to use its Broadcom GPU hardware for decoding h264 video. This needs the bcm2835_codec kernel module which is maintained -oustide the mainline Linux kernel by Raspberry Pi in the the Raspberry Pi kernel tree, and the only distributions for R Pi that are known to supply it include Raspberry Pi OS, Ubuntu, and Manjaro (all available from @@ -663,7 +663,13 @@ compiler.

    1. Download and install Bonjour SDK for Windows v3.0 from the official Apple site https://developer.apple.com/download

      2. +href="https://developer.apple.com/download/all/?q=Bonjour%20SDK%20for%20Windows">https://developer.apple.com/download. +(Apple makes you register as a developer to access it; if you do not +want to go through the registration process, you can download the SDK +without any registration at softpedia.com.) +This should install the Bonjour SDK as +C:\Program Files\Bonjour SDK

    2. (This is for 64-bit Windows; a build for 32-bit Windows should be possible, but is not tested.) The unix-like MSYS2 build environment will be used: download and install MSYS2 from the official site official GStreamer site, but only the MinGW 64-bit build on MSYS2 has been tested.

    3. cd to the UxPlay source directory, then -“mkdir build” and “cd build”, followed by

      +“mkdir build” and “cd build”. The build +process assumes that the Bonjour SDK is installed at +C:\Program Files\Bonjour SDK. If is somewhere else, set the +enviroment variable BONJOUR_SDK_HOME to point to its location. Then +build UxPlay with

      cmake ..

      ninja

    4. Assuming no error in either of these, you will have built the diff --git a/README.md b/README.md index 1483f33..ad6d449 100644 --- a/README.md +++ b/README.md @@ -399,7 +399,7 @@ better than earlier, with the new default timestamp-based synchronization to kee * For best performance, the Raspberry Pi needs the GStreamer Video4linux2 plugin to use its Broadcom GPU hardware for decoding h264 video. This needs the bcm2835_codec kernel module -which is maintained oustide the mainline Linux kernel by Raspberry Pi in the +which is maintained outside the mainline Linux kernel by Raspberry Pi in the the [Raspberry Pi kernel tree](https://github.com/raspberrypi/linux), and the only distributions for R Pi that are known to supply it include Raspberry Pi OS, Ubuntu, and Manjaro (all available from Raspberry Pi with their Raspberry Pi Imager). Other distributions generally do not @@ -529,7 +529,11 @@ seems fragile against attempts to change the X11 window size, or to rotations th * tested on Windows 10 and 11, 64-bit. 1. Download and install **Bonjour SDK for Windows v3.0** from the official Apple site - [https://developer.apple.com/download](https://developer.apple.com/download/all/?q=Bonjour%20SDK%20for%20Windows) + [https://developer.apple.com/download](https://developer.apple.com/download/all/?q=Bonjour%20SDK%20for%20Windows). (Apple + makes you register as a developer to access it; if you do not want to go through the registration process, you can download + the SDK without any registration at [softpedia.com](https://www.softpedia.com/get/Programming/SDK-DDK/Bonjour-SDK.shtml).) + This should install the Bonjour SDK as `C:\Program Files\Bonjour SDK` + 2. (This is for 64-bit Windows; a build for 32-bit Windows should be possible, but is not tested.) The unix-like MSYS2 build environment will be used: download and install MSYS2 from the official @@ -558,7 +562,9 @@ seems fragile against attempts to change the X11 window size, or to rotations th for Windows are available from the [official GStreamer site](https://gstreamer.freedesktop.org/download/), but only the MinGW 64-bit build on MSYS2 has been tested. -5. cd to the UxPlay source directory, then "`mkdir build`" and "``cd build``", followed by +5. cd to the UxPlay source directory, then "`mkdir build`" and "``cd build``". The build process assumes that + the Bonjour SDK is installed at `C:\Program Files\Bonjour SDK`. If is somewhere else, set the enviroment + variable BONJOUR_SDK_HOME to point to its location. Then build UxPlay with `cmake ..` diff --git a/README.txt b/README.txt index 02c25c9..c55c9be 100644 --- a/README.txt +++ b/README.txt @@ -483,7 +483,7 @@ See [Usage](#usage) for more run-time options. - For best performance, the Raspberry Pi needs the GStreamer Video4linux2 plugin to use its Broadcom GPU hardware for decoding h264 video. This needs the bcm2835_codec kernel module which is - maintained oustide the mainline Linux kernel by Raspberry Pi in the + maintained outside the mainline Linux kernel by Raspberry Pi in the the [Raspberry Pi kernel tree](https://github.com/raspberrypi/linux), and the only distributions for R Pi that are known to supply it include Raspberry @@ -666,7 +666,13 @@ device is rotated). 1. Download and install **Bonjour SDK for Windows v3.0** from the official Apple site - [https://developer.apple.com/download](https://developer.apple.com/download/all/?q=Bonjour%20SDK%20for%20Windows) + [https://developer.apple.com/download](https://developer.apple.com/download/all/?q=Bonjour%20SDK%20for%20Windows). + (Apple makes you register as a developer to access it; if you do not + want to go through the registration process, you can download the + SDK without any registration at + [softpedia.com](https://www.softpedia.com/get/Programming/SDK-DDK/Bonjour-SDK.shtml).) + This should install the Bonjour SDK as + `C:\Program Files\Bonjour SDK` 2. (This is for 64-bit Windows; a build for 32-bit Windows should be possible, but is not tested.) The unix-like MSYS2 build environment @@ -702,7 +708,10 @@ device is rotated). only the MinGW 64-bit build on MSYS2 has been tested. 5. cd to the UxPlay source directory, then "`mkdir build`" and - "`cd build`", followed by + "`cd build`". The build process assumes that the Bonjour SDK is + installed at `C:\Program Files\Bonjour SDK`. If is somewhere else, + set the enviroment variable BONJOUR_SDK_HOME to point to its + location. Then build UxPlay with `cmake ..`