Option record pass-thru now works.
[epichord.git] / doc / README
blob99799829d229b17b4237dd9f72b9c4aa5fbd7dc2
1 A midi sequencer for linux
2  _____       _      _                   _ 
3 | ____|_ __ (_) ___| |__   ___  _ __ __| |
4 |  _| | '_ \| |/ __| '_ \ / _ \| '__/ _` |
5 | |___| |_) | | (__| | | | (_) | | | (_| |
6 |_____| .__/|_|\___|_| |_|\___/|_|  \__,_|
7       |_|
10 **Epichord**
12 This is a program which I have heard described as a classical multi-track
13 midi sequencer. It allows you to arrange notes and patterns to be played on a
14 midi bus or record notes from some midi source. It does not make sound
15 and it does not handle audio in any way. That is the the job of other midi
16 aware softwares and hardware devices.
19 **where to get the source**
21 Epichord is licensed under the GNU GPL, so by using this program you implicitly
22 accept the ability to get the source code if you do not already have it.
24 the source is... somewhere...
27 **how to build**
29 Assuming you have a basic gnu/linux-type setup (a compiler, X, etc) you need 
30 some additional libs to build this program.
32 fltk-2.0      graphical user interface
33 jack-0.109.2  or any recent version of jack with midi support
35 After installing those, you can build and do a default install by:
37   ./configure
38   make
40 When the build finishes, run the following as root:
42   make install
45 If you have problems during configuration, read the error message.
46 If you have problems during make, contact the developer or fix the problem 
47 and contact the developer with the solution.
49 If you want to install to a different location than the default you must
50 pass the directory to configure like this
52   ./configure --prefix=/usr
54 You can also set the location where the program will search for graphics
55 and documentation:
57   ./configure --datadir=/usr/share
59 Currently this means the program will look in /usr/share/epichord/gfx 
60 for graphics and /usr/share/epichord/doc for documentation.
62 Run ./configure -h for more configuration options.
65 **How to get help**
67 If you cant figure out the controls read the list of controls in controls.txt
69 If you dont know what you are doing at all, you can read the guide.txt
71 As a last resort you can try to get help at #lad on freenode
73 All help is available from inside the program by pressing the ? button.
79 **FAQ**
81 Who wrote this software?
85 Why yet another midi sequencer. Aren't there enough already?
89 What is the grand over-arching philosophy of this program?
93 Why can I not load samples and audio clips?
97 Why did you use FLTK? It sucks!
101 Why did you use c++? It sucks!
105 Why did you use autoconf and automake? It sucks!
109 The name Epichord is too cutesy. Can't you think of a better name?
113 Will there be a Windows(R) version?
117 When will the next release, with many new features, be ready?
121 Can you please add feature XYZ?