A canceled load or import does not erase the song.
[epichord.git] / doc / README
blobe8be63d27bf2abd7767f1ee3dba330b787382b87
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
39 lash          use the latest version if you want to actually use lash
41 Lash is currently required because autoconf does not define-or-not HAVE_LASH
42 based on whether lash is available. If you would like to add this to the
43 configure.ac please do and contribute your changes.
45 After installing those, you can build and do a default install by:
47   ./configure
48   make
50 When the build finishes, run the following as root:
52   make install
55 If you have problems during configuration, read the error message.
56 If you have problems during make, contact the developer or fix the problem 
57 and contact the developer with the solution.
59 If you want to install to a different location than the default you must
60 pass the directory to configure like this
62   ./configure --prefix=/usr
64 You can also set the location where the program will search for graphics
65 and documentation:
67   ./configure --datadir=/usr/share
69 Currently this means the program will look in /usr/share/epichord/gfx 
70 for graphics and /usr/share/epichord/doc for documentation.
72 Run ./configure -h for more configuration options.
75 **How to get help**
77 If you cant figure out the controls read the list of controls in controls.txt
79 If you dont know what you are doing at all, you can read the guide.txt
81 As a last resort you can try to get help at #lad on freenode
83 All help is available from inside the program by pressing the ? button.
89 **FAQ**
91 Who wrote this software?
95 Why yet another midi sequencer. Aren't there enough already?
99 What is the grand over-arching philosophy of this program?
103 Why can I not load samples and audio clips?
107 Why did you use FLTK? It sucks!
111 Why did you use c++? It sucks!
115 Why did you use autoconf and automake? It sucks!
119 The name Epichord is too cutesy. Can't you think of a better name?
123 Will there be a Windows(R) version?
127 When will the next release, with many new features, be ready?
131 Can you please add feature XYZ?