Added 'win32dist' Makefile target.
[ahxm.git] / README
blob085c1a54bcc78bab761359596f71152ffca9fc97
1 Ann Hell Ex Machina README
2 ==========================
4  Ann Hell Ex Machina - Music programming language and compiler
5  Copyright (C) 2003-2011 Angel Ortega <angel@triptico.com>
6  Home Page: http://triptico.com/software/ahxm.html
8 This software is GPL. NO WARRANTY. See file 'COPYING' for details.
10 Introduction
11 ------------
13 Ann Hell Ex Machina (AHXM) is a set of tools for composing and generating
14 music. Given a text file in a special-purpose music definition programming
15 language (the Ann Hell Scripting, or AHS for short), it outputs
16 multi-channel wave files much like a music compiler. The included software
17 synthesizer supports raw PCM, .wav, .pat and .sf2 files as instrument
18 definitions and a full set of digital filters as echoes, flangers and
19 reverbs. MIDI output to external synthesizers is also supported.
21 The AHS language resembles text-based music markup as the one in Lilypond,
22 with more specialized commands for the PCM wave generation, digital effects
23 or the MIDI definitions. Simple notes and chords, repeating blocks,
24 patterns, arpeggiators, tempo and measure changes, transpositions, staccato
25 / tenuto, marks, random blocks, are all usable via simple (usually
26 one-letter) commands. Stereo, quad, 5.1 or whatever desired number of audio
27 channels can be used and each software synthesizer note be mapped to any of
28 them freely. Input formats not directly supported can be used via external
29 filters.
31 This is a very personal project and its features are fitted to my own way of
32 making music, so there may be missing capabilities that you, as a musician,
33 consider essential, and others that you may see as superfluous. I don't
34 care. This software is made for me, by me. I'll consider any patch from
35 external developers, but only accept the ones I feel meet my needs.
37 This software is designed for Unix/Linux systems, but also runs under win32.
39 If you want to hear examples of music made with Ann Hell Ex Machina, go to
40 http://triptico.com/annhell/ (the Ann Hell Home Page).
42 Compiling and installing
43 ------------------------
45 As always,
47         ./config.sh
48         make
49         su -c "make install"
51 As this program relies heavily in floating pointing arithmetic, it can
52 benefit greatly from compiler optimizations, so you can try:
54         CFLAGS="-O2 -ffast-math" ./config.sh
55         make
56         su -c "make install"
58 ----
59 Angel Ortega - http://triptico.com