From d98fd8f85d02a7217467fe23a73a4323b9c2bd7d Mon Sep 17 00:00:00 2001 From: fduncanh Date: Wed, 6 Apr 2022 17:41:23 -0400 Subject: [PATCH] edit README --- README.html | 3 ++- README.md | 8 +++++--- README.txt | 20 ++++++++++++-------- 3 files changed, 19 insertions(+), 12 deletions(-) diff --git a/README.html b/README.html index 9e7aff9..aa8725f 100644 --- a/README.html +++ b/README.html @@ -31,8 +31,9 @@

*Current UxPlay is also a pull request on the original site https://github.com/antimof/UxPlay ; that original project is inactive, but the pull requests are now being periodically merged with the antimof tree (thank you antimof!).

Building UxPlay on Linux (or *BSD):

(Instructions for Debian/Ubuntu; adapt these for other Linuxes; for macOS, see below). See Troubleshooting below for help with any difficulties.

+

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. You also need pkg-config: if it is is not found by “which pkg-config”, install either pkg-config or its work-alike replacement pkgconf. Also make sure that cmake>=3.4.1 is installed: “sudo apt-get install cmake” (add build-essential and pkgconf to this if needed).

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

-

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 follow the instructions below:

+

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 follow the instructions below:

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 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. diff --git a/README.md b/README.md index 3778791..7829a54 100644 --- a/README.md +++ b/README.md @@ -122,13 +122,15 @@ now being periodically merged with the antimof tree (thank you antimof!). (Instructions for Debian/Ubuntu; adapt these for other Linuxes; for macOS, see below). See [Troubleshooting](#troubleshooting) below for help with any difficulties. +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. You also need pkg-config: if it is is not found by "`which pkg-config`", +install either pkg-config or its work-alike replacement pkgconf. Also make sure that cmake>=3.4.1 +is installed: "`sudo apt-get install cmake`" (add ``build-essential`` and ```pkgconf``` to this if needed). + 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). -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 follow the instructions below: diff --git a/README.txt b/README.txt index 4eda096..ea1cdbd 100644 --- a/README.txt +++ b/README.txt @@ -159,19 +159,23 @@ Building UxPlay on Linux (or \*BSD): macOS, see below). See [Troubleshooting](#troubleshooting) below for help with any difficulties. +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. You also need +pkg-config: if it is is not found by "`which pkg-config`", install +either pkg-config or its work-alike replacement pkgconf. Also make sure +that cmake\>=3.4.1 is installed: "`sudo apt-get install cmake`" (add +`build-essential` and `pkgconf` to this if needed). + 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). -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 follow the instructions below: +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 follow +the instructions below: **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