From 37ba9dd1ce449bc2c2f422dd04225bc68bd89c59 Mon Sep 17 00:00:00 2001
From: Chris Xiong <chirs241097@gmail.com>
Date: Fri, 2 Jun 2017 21:12:27 +0800
Subject: Some changes from earlier this year. Read ChangeLog for details.

---
 INSTALL.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 INSTALL.md

(limited to 'INSTALL.md')

diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..e9e5c8d
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,37 @@
+# General instructions
+Use qmake or Qt Creator.
+
+Dependencies:
+
+> libfluidsynth 1.1.4+, Qt5, Qt5 Qt quick controls(lite version) and RtMidi.
+
+C++11 is _required_ to build the project. Qt4 will not work without
+several tweaks.
+
+To build the default visualization plugin, you need the latest SMELT library
+(along with all its dependencies), which can be found
+[here](https://github.com/BearKidsTeam/SMELT).
+
+Some dependencies in the project file are hard-coded paths. You may
+have to modify them first. Alternatively, you can set the environmental
+variable `SMELT_DIR` to where your SMELT build is.
+
+If you don't want to build the default visualization plugin, just remove
+the line containing "visualization" in qmidiplayer.pro.
+
+# Instruction for dumbs
+
+1. Get SMELT [here](https://github.com/BearKidsTeam/SMELT).
+2. Get the source code [here](https://github.com/chirs241097/QMidiPlayer).
+3. The following steps are done in an interactive shell.
+4. Change directory (`cd`) to the folder with the source code of SMELT.
+   type `make` to build it.
+5. Type `export QMP_BUILD_MODE=1` to allow QMP to scan plugins in
+   /usr/lib/qmidiplayer.
+6. Type `export SMELT_DIR=<path to the folder with SMELT in it>` in order
+   to tell qmake where SMELT is.
+7. Change directory to the folder with the source code of QMidiPlayer.
+   type `qmake` and then `make` to build it. Appending `PREFIX=/usr` to `qmake`
+   is highly recommended because QMidiPlayer only scans for plugins in 
+   working directory and /usr/lib/qmidiplayer at this moment.
+8. Use `sudo make install` to install QMidiPlayer.
-- 
cgit v1.2.3