From b5ca48b20bd04e2e127bb7ef094429aa10287c45 Mon Sep 17 00:00:00 2001 From: Dan Fabulich Date: Tue, 16 Jan 2024 17:42:08 -0800 Subject: [PATCH 1/4] Convert INSTALL instructions to Markdown --- INSTALL => INSTALL.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) rename INSTALL => INSTALL.md (85%) diff --git a/INSTALL b/INSTALL.md similarity index 85% rename from INSTALL rename to INSTALL.md index d3d73bf..9270471 100644 --- a/INSTALL +++ b/INSTALL.md @@ -2,7 +2,7 @@ First of all, if you're on Gentoo Linux or some other portage-based system, then there's no need to continue; QTads is in portage and you can install it normally with: - emerge games-engines/qtads + emerge games-engines/qtads For all other Linux distributions, a self-contained AppImage binary is provided on the download page. If you still want to build QTads yourself from source, @@ -10,9 +10,9 @@ read on. QTads uses qmake as its build system. To build it: - cd - qmake PREFIX=/usr/local - make -j4 + cd + qmake PREFIX=/usr/local + make -j4 Replace "-j4" with the amount of CPUs on your machine. "-j2" for a dual-core CPU, for example. Specifying PREFIX is optional. If you omit it, the default @@ -22,7 +22,7 @@ This will create a "qtads" binary which you can then copy and run from anywhere. There are no files that need to be installed, although can do a full installation as well with: - make install + make install This will install all files into /usr/local, unless you specified a different PREFIX. This will also install a desktop file and MIME information data for @@ -32,20 +32,20 @@ you don't have write permission for the specified PREFIX. You can disable audio support when building by running qmake like this instead: - qmake -config disable-audio + qmake -config disable-audio This will produce a version of QTads that does not support audio. For it to build correctly, you will need to have the Qt5 libraries along with their development headers/tools installed. You need at least Qt 5.5. - + If audio support is enabled, you'll also need: - SDL 2 - libsndfile - libfluidsynth (version 2.x) - libvorbisfile - libmpg123 + SDL 2 + libsndfile + libfluidsynth (version 2.x) + libvorbisfile + libmpg123 Most Linux distributions provide the development versions in packages that have "-dev" appended to the package name. From 12a6cc385a2248500f4539281bc73121d86d01a5 Mon Sep 17 00:00:00 2001 From: Dan Fabulich Date: Tue, 16 Jan 2024 17:47:24 -0800 Subject: [PATCH 2/4] Mention dependencies before building --- INSTALL.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 9270471..81dce3b 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -8,6 +8,24 @@ For all other Linux distributions, a self-contained AppImage binary is provided on the download page. If you still want to build QTads yourself from source, read on. +# Dependencies + +For QTads to build correctly, you will need to have the Qt5 libraries along with +their development headers/tools installed. You need at least Qt 5.5. + +If audio support is enabled, you'll also need: + + SDL 2 + libsndfile + libfluidsynth (version 2.x) + libvorbisfile + libmpg123 + +Most Linux distributions provide the development versions in packages that have +"-dev" appended to the package name. + +# Building + QTads uses qmake as its build system. To build it: cd @@ -35,17 +53,3 @@ You can disable audio support when building by running qmake like this instead: qmake -config disable-audio This will produce a version of QTads that does not support audio. - -For it to build correctly, you will need to have the Qt5 libraries along with -their development headers/tools installed. You need at least Qt 5.5. - -If audio support is enabled, you'll also need: - - SDL 2 - libsndfile - libfluidsynth (version 2.x) - libvorbisfile - libmpg123 - -Most Linux distributions provide the development versions in packages that have -"-dev" appended to the package name. From cbdfcb49fcb8db6858b717344c081f8ae83f2e2f Mon Sep 17 00:00:00 2001 From: Dan Fabulich Date: Tue, 16 Jan 2024 17:48:58 -0800 Subject: [PATCH 3/4] Document that QTads doesn't work with Qt6 --- INSTALL.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index 81dce3b..08be015 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -11,7 +11,9 @@ read on. # Dependencies For QTads to build correctly, you will need to have the Qt5 libraries along with -their development headers/tools installed. You need at least Qt 5.5. +their development headers/tools installed. You need at least Qt 5.5. (As of +January 2024, QTads is not compatible with Qt6.) +https://github.com/realnc/qtads/issues/23 If audio support is enabled, you'll also need: From 6460636a838a69b070d7d6239bad99331e98e8ac Mon Sep 17 00:00:00 2001 From: Dan Fabulich Date: Tue, 16 Jan 2024 17:49:26 -0800 Subject: [PATCH 4/4] Document how to install dependencies on macOS --- INSTALL.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/INSTALL.md b/INSTALL.md index 08be015..4e37c4e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -26,6 +26,15 @@ If audio support is enabled, you'll also need: Most Linux distributions provide the development versions in packages that have "-dev" appended to the package name. +On macOS, you can use Homebrew to install dependencies. https://brew.sh/ + + brew install qt@5 + +Homebrew installs QT 5 "keg-only," and it will include a line like this, +explaining how to add it to your $PATH. + + export PATH="/opt/homebrew/opt/qt@5/bin:$PATH" + # Building QTads uses qmake as its build system. To build it: