X-Git-Url: https://code.delx.au/virtualtones/blobdiff_plain/dbf3c275fdcd6a94bb63ba2346b8f89dbfe35380..186e6de6a52f293a6169a5f7790ff03c6790c733:/README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c2fa2bb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,64 @@
+# VirtualTones
+
+## About
+
+This program was written by James Bunton <jamesbunton@delx.net.au>
+It is licensed under the terms of the GNU GPL version 2
+(see COPYING.txt for more details)
+
+This program was written for Julieanne.. :-)
+Hope you like your Christmas present!
+
+If you have any feature requests, bug reports, etc, send them to me.
+Thanks and enjoy..
+
+
+## Update
+
+This was originally written back in in 2003 for Qt 2.3. I've recently
+updated it to work with modern Linux.
+
+
+
+## Instructions
+
+If you are using Windows 95 or later, you need a MIDI device set up.
+If running `VirtualTones.exe` does not work, go to
+Start->Control Panel->Multimedia and select a synthesiser.
+
+
+If you are using Linux, make sure you have a sequencer set up.
+Timidity++ is a good one, start it up in ALSA client mode:
+
+```
+timidity -iA -Os -c /etc/timidity++/timidity-freepats.cfg
+```
+
+
+
+## Compiling
+
+```
+cd virtualtones
+qmake
+make
+```
+
+
+## Todo
+
+* 'Clean' the MIDI files so that notes are saved as with the exact
+  lengths of crotchets, quavers, etc. This means opening the file in a
+  notation editor, such as Finale or Rosegarden would give better
+  results.
+
+
+
+## Bugs
+
+* It is impossible to push certain combinations of keys.
+    (A problem with the OS, or keyboard hardware?)
+
+* Contrabass interface is a bit weird, but works mostly ok
+
+* Sizes of pixmaps is off