Fixed initial middle click on arranger segfaults.
[epichord.git] / doc / README
blob2da288dad9bb2a3dc7be048ba3f28099451901f1
1 A midi sequencer
2  _____       _      _                   _ 
3 | ____|_ __ (_) ___| |__   ___  _ __ __| |
4 |  _| | '_ \| |/ __| '_ \ / _ \| '__/ _` |
5 | |___| |_) | | (__| | | | (_) | | | (_| |
6 |_____| .__/|_|\___|_| |_|\___/|_|  \__,_|
7       |_|
10 **Epichord**
12 Epichord is a midi sequencer. It allows you to arrange midi patterns to be 
13 played on midi aware tools, record midi, and store/load arrangements to/from 
14 disk. It does not make sound or handle audio in any way. That is the job of 
15 other midi programs and hardware to which it can connect.
17 **where to get the source**
19 Epichord is licensed under the GNU GPL, so by using this program you implicitly
20 accept the ability to get the source code if you do not already have it.
22 the source is in a git repo at http://repo.or.cz/w/epichord.git
24 Use the following command to get a clone of the repo which you can use
25 to easily get updates to the very latest version, or to make improvments
26 and submit them. The repo has the mob branch enabled so you do not need
27 a password to use that branch.
29 git clone git://repo.or.cz/epichord.git
32 **how to build**
34 Assuming you have a basic gnu/linux-type setup (a compiler, X, etc) you need 
35 some additional libs to build this program.
37 fltk-2.0      graphical user interface
38 jack-0.109.2  or any recent version of jack with midi support
40 optional dependencies:
42 lash          use the latest version if you want to actually use lash
44 After installing those, you can build and do a default install by:
46   ./configure
47   make
49 When the build finishes, run the following as root:
51   make install
54 If you have problems during configuration, read the error message.
55 If you have problems during make, contact the developer or fix the problem 
56 and contact the developer with the solution.
58 If you want to install to a different location than the default you must
59 pass the directory to configure like this
61   ./configure --prefix=/usr
63 You can also set the location where the program will search for graphics
64 and documentation:
66   ./configure --datadir=/usr/share
68 Currently this means the program will look in /usr/share/epichord/gfx 
69 for graphics and /usr/share/epichord/doc for documentation.
71 Run ./configure -h for more configuration options.
74 **How to get help**
76 If you cant figure out the controls read the list of controls in controls.txt
78 If you dont know what you are doing at all, you can read the guide.txt
80 As a last resort you can try to get help at #lad on freenode
82 All help is available from inside the program by pressing the ? button.
88 **FAQ**
90 Who wrote this software?
94 Why yet another midi sequencer. Aren't there enough already?
98 What is the grand over-arching philosophy of this program?
102 Why can I not load samples and audio clips?
106 Why did you use FLTK? It sucks!
110 Why did you use c++? It sucks!
114 Why did you use autoconf and automake? It sucks!
118 The name Epichord is too cutesy. Can't you think of a better name?
122 Will there be a Windows(R) version?
126 When will the next release, with many new features, be ready?
130 Can you please add feature XYZ?