Fixed one segfault during undo.
[epichord.git] / doc / README
blob7564e995cc6191b8d387602ce6dc2be00c0c0296
1 A midi sequencer
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 in a git repo at http://repo.or.cz/w/epichord.git
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
34 lash          use the latest version if you want to actually use lash
36 Lash is currently required because autoconf does not define-or-not HAVE_LASH
37 based on whether lash is available. If you would like to add this to the
38 configure.ac please do and contribute your changes.
40 After installing those, you can build and do a default install by:
42   ./configure
43   make
45 When the build finishes, run the following as root:
47   make install
50 If you have problems during configuration, read the error message.
51 If you have problems during make, contact the developer or fix the problem 
52 and contact the developer with the solution.
54 If you want to install to a different location than the default you must
55 pass the directory to configure like this
57   ./configure --prefix=/usr
59 You can also set the location where the program will search for graphics
60 and documentation:
62   ./configure --datadir=/usr/share
64 Currently this means the program will look in /usr/share/epichord/gfx 
65 for graphics and /usr/share/epichord/doc for documentation.
67 Run ./configure -h for more configuration options.
70 **How to get help**
72 If you cant figure out the controls read the list of controls in controls.txt
74 If you dont know what you are doing at all, you can read the guide.txt
76 As a last resort you can try to get help at #lad on freenode
78 All help is available from inside the program by pressing the ? button.
84 **FAQ**
86 Who wrote this software?
90 Why yet another midi sequencer. Aren't there enough already?
94 What is the grand over-arching philosophy of this program?
98 Why can I not load samples and audio clips?
102 Why did you use FLTK? It sucks!
106 Why did you use c++? It sucks!
110 Why did you use autoconf and automake? It sucks!
114 The name Epichord is too cutesy. Can't you think of a better name?
118 Will there be a Windows(R) version?
122 When will the next release, with many new features, be ready?
126 Can you please add feature XYZ?