aboutsummaryrefslogtreecommitdiff
path: root/README_BUILD.md
diff options
context:
space:
mode:
authoroldmud0 <oldmud0@users.noreply.github.com>2019-01-02 09:40:38 -0600
committerGitHub <noreply@github.com>2019-01-02 09:40:38 -0600
commit4d93f059c01664ad074cf467e79a63b85e86beb0 (patch)
tree57b8a9760796937e66e393b3bc00f4bee4337bdf /README_BUILD.md
parent6f1bce5882676ea7affe717a2f5a00b8c3b7fe12 (diff)
parentec1057b5d7e1d39963275bc2cbd79a53cf6f3f5c (diff)
Merge pull request #54 from OmniTroid/master
Restructuring + better cross-platform support
Diffstat (limited to 'README_BUILD.md')
-rw-r--r--README_BUILD.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/README_BUILD.md b/README_BUILD.md
new file mode 100644
index 0000000..685699c
--- /dev/null
+++ b/README_BUILD.md
@@ -0,0 +1,43 @@
+### Dependencies
+
+This program has five main dependencies
+
+* Qt 5.6+ (https://www.qt.io/download)
+* BASS (http://www.un4seen.com/bass.html)
+* BASS Opus Plugin (http://www.un4seen.com/bass.html#addons)
+* Discord Rich Presence (https://github.com/discordapp/discord-rpc/releases)
+* Qt Apng Plugin (https://github.com/Skycoder42/QtApng/releases)
+
+### How to build dynamically (the easy way)
+
+What you want to do is first download the latest version of Qt from the first link. (get the prebuilt dynamic version)
+If you're on Ubuntu, go to the scripts/ folder and run configure_ubuntu.sh. This should fetch all the required dependencies automatically.
+If not, go to each one of the links above and find the right dynamic library for your platform:
+* Windows: .dll
+* Linux: .so
+* Mac: .dylib
+
+And put them in BOTH lib/ and the repository root (lib/ is required for linking and root is required for runtime)
+
+Launch Qt creator, open the .pro file and try running it. Ask in the Discord if you're having issues: https://discord.gg/wWvQ3pw
+
+### How to build statically (the hard way)
+
+You're gonna have a bad time.
+
+Building statically means you can distribute the final program without needing to pack alongside a lot of dynamic libraries.
+This is a tricky process and is not recommended unless you know what you're doing.
+
+First, you need to build the entirety of Qt statically. To do this, check the desired version under "Sources" in the Qt maintenance tool.
+After this is done, follow these instructions: https://dimitris.apeiro.gr/2015/06/24/build-a-static-qt5-for-windows-by-compiling/
+This guide is specifically for Windows, but Qt is cross-platform and you should be good with or without some minor adjustments to the guide.
+Note that this **is** a computationally heavy process and will take a lot of time on a slow computer.
+After this, you need to configure the project to use the static version of qmake (see http://doc.qt.io/qtcreator/creator-build-settings.html)
+
+BASS and BASS Opus only comes as dynamic libraries and is not open-source. That means you can't link it statically in the program.
+
+For Discord RPC, you can download prebuilt static libraries for your platform. Just put them in lib/.
+
+For Qt Apng Plugin, you need to compile it statically. This guide does not go into detail how to configure this to build a static library. You may have to add Q_IMPORT_PLUGIN(ApngImagePlugin); in main.cpp. See more about importing static plugins here: http://doc.qt.io/qt-5/plugins-howto.html#static-plugins
+It's also possible to just link this dynamically.
+