aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Chris Xiong <chirs241097@gmail.com> 2016-04-17 23:26:47 +0800
committerGravatar Chris Xiong <chirs241097@gmail.com> 2016-04-17 23:26:47 +0800
commitb21f97f416cea5d9d86e3b28bd797b42491fc5a9 (patch)
treecbff050bf1e0304ee5afc136e19459516300b35e /doc
parentf3694385610a66215b65fafc1e05680baddeb090 (diff)
downloadQMidiPlayer-b21f97f416cea5d9d86e3b28bd797b42491fc5a9.tar.xz
Documentation...
Diffstat (limited to 'doc')
-rw-r--r--doc/channeldialog.html1
-rw-r--r--doc/channeleditor.html1
-rw-r--r--doc/cmdargs.html1
-rw-r--r--doc/efxdialog.html1
-rw-r--r--doc/index.html1
-rw-r--r--doc/license.html1
-rw-r--r--doc/mainwindow.html1
-rw-r--r--doc/miscellaneous.html72
-rw-r--r--doc/optionsdialog.html1
-rw-r--r--doc/plistdialog.html1
-rw-r--r--doc/troubleshooting.html1
-rw-r--r--doc/version.html1
12 files changed, 83 insertions, 0 deletions
diff --git a/doc/channeldialog.html b/doc/channeldialog.html
index a4e5fd2..12d6554 100644
--- a/doc/channeldialog.html
+++ b/doc/channeldialog.html
@@ -16,6 +16,7 @@
<li><a href="optionsdialog.html">Settings</a></li>
<li><a href="cmdargs.html">Commandline arguments</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="miscellaneous.html">Miscellaneous</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
diff --git a/doc/channeleditor.html b/doc/channeleditor.html
index fb50cc5..146e9b4 100644
--- a/doc/channeleditor.html
+++ b/doc/channeleditor.html
@@ -16,6 +16,7 @@
<li><a href="optionsdialog.html">Settings</a></li>
<li><a href="cmdargs.html">Commandline arguments</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="miscellaneous.html">Miscellaneous</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
diff --git a/doc/cmdargs.html b/doc/cmdargs.html
index 753ba2a..b0b97bb 100644
--- a/doc/cmdargs.html
+++ b/doc/cmdargs.html
@@ -16,6 +16,7 @@
<li><a href="optionsdialog.html">Settings</a></li>
<li><a class="active" href="cmdargs.html">Commandline arguments</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="miscellaneous.html">Miscellaneous</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
diff --git a/doc/efxdialog.html b/doc/efxdialog.html
index 4f95849..81fbecd 100644
--- a/doc/efxdialog.html
+++ b/doc/efxdialog.html
@@ -16,6 +16,7 @@
<li><a href="optionsdialog.html">Settings</a></li>
<li><a href="cmdargs.html">Commandline arguments</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="miscellaneous.html">Miscellaneous</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
diff --git a/doc/index.html b/doc/index.html
index ad21637..27e6601 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -16,6 +16,7 @@
<li><a href="optionsdialog.html">Settings</a></li>
<li><a href="cmdargs.html">Commandline arguments</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="miscellaneous.html">Miscellaneous</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
diff --git a/doc/license.html b/doc/license.html
index fcba8cf..64ec3c5 100644
--- a/doc/license.html
+++ b/doc/license.html
@@ -20,6 +20,7 @@
<li><a href="optionsdialog.html">Settings</a></li>
<li><a href="cmdargs.html">Commandline arguments</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="miscellaneous.html">Miscellaneous</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a class="active" href="license.html">License</a></li>
</ul>
diff --git a/doc/mainwindow.html b/doc/mainwindow.html
index a054c58..22fb0bb 100644
--- a/doc/mainwindow.html
+++ b/doc/mainwindow.html
@@ -16,6 +16,7 @@
<li><a href="optionsdialog.html">Settings</a></li>
<li><a href="cmdargs.html">Commandline arguments</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="miscellaneous.html">Miscellaneous</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
diff --git a/doc/miscellaneous.html b/doc/miscellaneous.html
new file mode 100644
index 0000000..defcbf4
--- /dev/null
+++ b/doc/miscellaneous.html
@@ -0,0 +1,72 @@
+<!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="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 Basic functionality</li>
+ <li>0.6 Settings and experimental Windows support</li>
+ <li>0.7 MIDI mapping, first stable version</li>
+ <li>0.8 Visualization</li>
+ <li>0.9 Stable 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>
+ <h3 id="contact">Contact the author</h3>
+ <p>
+ E-mail: chirs241097 'at' gmail 'dot' com
+ Twitter: @chirs241097
+ </p>
+ </div>
+</body>
+</html> \ No newline at end of file
diff --git a/doc/optionsdialog.html b/doc/optionsdialog.html
index a033261..1854f57 100644
--- a/doc/optionsdialog.html
+++ b/doc/optionsdialog.html
@@ -16,6 +16,7 @@
<li><a class="active" href="optionsdialog.html">Settings</a></li>
<li><a href="cmdargs.html">Commandline arguments</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="miscellaneous.html">Miscellaneous</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
diff --git a/doc/plistdialog.html b/doc/plistdialog.html
index ae14678..10596be 100644
--- a/doc/plistdialog.html
+++ b/doc/plistdialog.html
@@ -16,6 +16,7 @@
<li><a href="optionsdialog.html">Settings</a></li>
<li><a href="cmdargs.html">Commandline arguments</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="miscellaneous.html">Miscellaneous</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
diff --git a/doc/troubleshooting.html b/doc/troubleshooting.html
index f98e768..09273cf 100644
--- a/doc/troubleshooting.html
+++ b/doc/troubleshooting.html
@@ -16,6 +16,7 @@
<li><a href="optionsdialog.html">Settings</a></li>
<li><a href="cmdargs.html">Commandline arguments</a></li>
<li><a class="active" href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="miscellaneous.html">Miscellaneous</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
diff --git a/doc/version.html b/doc/version.html
index 050ab09..b28ca13 100644
--- a/doc/version.html
+++ b/doc/version.html
@@ -16,6 +16,7 @@
<li><a href="optionsdialog.html">Settings</a></li>
<li><a href="cmdargs.html">Commandline arguments</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="miscellaneous.html">Miscellaneous</a></li>
<li><a class="active" href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-01 07:07:50 +0000