summaryrefslogtreecommitdiff
path: root/QMidiPlayer/doc/miscellaneous.html
blob: d8e90c34b68c29bf5e5e838a78ba5b3536ebf27e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<!DOCTYPE html>
<html>
<head>
<title>QMidiPlayer Help</title>
<link rel=stylesheet href='styles.css' type='text/css'>
</head>
<body>
	<div id="panel">
		<ul>
			<li><a href="index.html">Overview</a></li>
			<li><a href="mainwindow.html">Main Window</a></li>
			<li><a href="channeldialog.html">Channels Dialog</a></li>
			<li><a href="channeleditor.html">Channel Editor</a></li>
			<li><a href="plistdialog.html">Playlist</a></li>
			<li><a href="efxdialog.html">Effects</a></li>
			<li><a href="optionsdialog.html">Settings</a></li>
			<li><a href="visualization.html">Visualization</a></li>
			<li><a href="cmdargs.html">Commandline arguments</a></li>
			<li><a href="troubleshooting.html">Troubleshooting</a></li>
			<li><a class="active" href="miscellaneous.html">Miscellaneous</a></li>
			<li><a href="version.html">Version Info.</a></li>
			<li><a href="license.html">License</a></li>
		</ul>
	</div>
	<div id="content">
		<ul>
			<li><a href="#build">Building QMidiPlayer from source</a></li>
			<li><a href="#ms">Roadmap/Milestones</a></li>
			<li><a href="#faq">FAQs</a></li>
			<li><a href="#contact">Contact the author</a></li>
		</ul>
		<h3 id="build">Building QMidiPlayer from source</h3>
		Building QMidiPlayer from source is as easy as any other qmake projects.<br>
		1. Get the dependencies.<br>
		Currently QMidiPlayer depends on these libraries:<br>
		<pre style="background-color:#eee;padding:0.2em;">qt5, libfluidsynth(FluidSynth), librtmidi(RtMidi)</pre>
		If you want to build the lite version as well, you need several QML core modules.<br>
		Get the libraries for your platform, open the project with Qt Creator, configure and hit Build!
		(You may also use the qmake-make way).<br>
		Please note that QMidiPlayer <i>requires</i> C++11 to build.
		<h3 id="ms">Roadmap/Milestones</h3>
		<ul>
			<li>0.5.x  Basic functionality</li>
			<li>0.6.x  Settings and experimental Windows support</li>
			<li>0.7.2  MIDI mapping, first stable version</li>
			<li>0.7.8  Plugin interface, UI refactoring</li>
			<li>0.8.x  Visualization (the default visualization plugin).</li>
			<li>0.8.5+ File reader plugin API, event filter/modifier API. </li>
			<li>0.9.x  API Stablization. Revive lite version.</li>
			<li>1.x+   Translation, documentation, Maintaince only.</li>
		</ul>
		<h3 id="faq">FAQs</h3>
		<h4>0. (Windows version) It complains about a missing dll!</h4>
		<p>
		Please download and install <a href="https://www.microsoft.com/en-us/download/details.aspx?id=48145">
		Visual Studio 2015 Runtime Library</a>.
		</p>
		<h4>1. Can I help translate this program?</h4>
		<p>
		Of course! Please make a pull request or contact me.
		</p>
		<h4>2. I have found a bug in this program. Where to report the bug?</h4>
		<p>
		Please use the <a href="https://github.com/chirs241097/QMidiPlayer/issues">
		github issue tracker</a>. Don't forget to check if the bug has already been
		fixed in a newer version!
		</p>
		<h4>3. On what platform(s) do you develop this project?</h4>
		<p>
		Major platforms used:
        <ul>
            <li>Debian GNU/Linux unstable(sid) amd64 on custom machine (i7-2960XM, 16GB RAM, GTX960, X9SCV-QV4)</li>
            <li>Arch Linux amd64 on a Lenovo ThinkPad X1 yoga 1st Gen. (i7-6600U, 16GB RAM, HD520)</li>
        </ul>
        Platforms for building the Windows version:
        <ul>
            <li>Windows 10 Insider Pro on the ThinkPad X1 yoga mentioned above.</li>
        </ul>
		</p>
		<h3 id="contact">Contact the author</h3>
		<p>
		E-mail: chirs241097 'at' gmail 'dot' com<br>
		Twitter: @chirs241097
		</p>
	</div>
</body>
</html>