root/tags/release-0.7.1/README

Revision 557, 3.9 kB (checked in by olivier, 16 months ago)

fix readme rst formatting

Line 
1===============================
2Jackbeat - Audio Sequencer
3===============================
4
5Introduction
6============
7
8Jackbeat is an audio sequencer running on Linux and Mac OS X, for musicians
9and sound artists:
10
11* Drummachine interface with animations for easy and playful editing
12* Built for both composition and live setups with high interactivity needs
13* Extremely easy to use but yet powerful by connecting with other
14  applications and plugins using JACK and OSC
15* Loads and saves .jab files, Jackbeat's xml+tar open file format
16* Supports native audio devices, PulseAudio and JACK
17
18Requirements
19============
20
21Required dependencies
22~~~~~~~~~~~~~~~~~~~~~
23
24* PortAudio (http://www.portaudio.com/)
25
26* Linux only: libasound (http://www.alsa-project.org)
27
28* GTK+-2.0 (gtk.org)
29
30* libsndfile (www.mega-nerd.com/libsndfile)
31
32* libxml2 (http://xmlsoft.org)
33
34* libsamplerate (http://www.mega-nerd.com/SRC)
35
36* liblo (http://liblo.sourceforge.net)
37
38Optional dependencies
39~~~~~~~~~~~~~~~~~~~~~
40
41* JACK, the Jack Audio Connection Kit (http://jackaudio.org) : a running server
42  as well as the API header files. Mac OS X users should see
43  http://www.jackosx.com
44
45* PulseAudio (http://www.pulseaudio.org)
46
47Installation
48============
49
50Jackbeat uses autoconf and automake, so you should just need to type::
51
52    ./configure
53    make
54    make install
55
56This should be straightforward on Linux.
57
58For Mac OS X please check:
59http://jackbeat.samalyse.org/wiki/MacInstallation
60
61Developer/maintainer mode
62=========================
63
64If you want to compile Jackbeat and run it without installation, you
65need to::
66
67    ./configure --enable-devmode
68    make
69    # run jackbeat from the current directory:
70    src/jackbeat
71
72Usage
73=====
74
75Jackbeat is pretty simple to use. Browse through the main menu, it is meant to
76be quite obvious. The Sequence and Track buttons at the bottom of the window
77open the corresponding properties panel where you'll find convenient functions.
78
79To begin, just a load a few samples using the track panel properties or the edit menu.
80Then by toggling some of the buttons on the drummachine and clicking Play you shall
81hear some music. Well... hopefully ;)
82
83Notes about export parameters
84~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
85
86When you export the current sequence as a WAV file, you are given a choice
87about how to handle samples that continue playing passed the end of the sequence:
88
89  - loop: mix at the beginning. This is optimal for playing the exported
90    WAV file as a loop in some external software.
91  - truncate: don't play at all. This will sound like the initial sequence
92    playback, before it has looped at least once.
93  - keep: continue playing samples until they terminate. Beware that the
94    exported file may thus be (much) longer than the sequence.
95
96The double function
97~~~~~~~~~~~~~~~~~~~
98
99Available in the Edit menu, Double increases the beats number by a factor of 2,
100and duplicates the beats data. This feature allows you to increase your workspace
101size, while keeping the output unchanged.
102
103About track masking
104~~~~~~~~~~~~~~~~~~~
105
106Track masks allow you to insert silences into a track interactively.
107 
108Use Shift-Click (or press N) to toggle the mask for a given beat. The corresponding track
109will then get muted during the duration of that beat.
110
111Keyboard shortcuts
112~~~~~~~~~~~~~~~~~~
113
114You can learn about most of the keyboard shortcuts by looking at the main menu.
115
116There also are a few pattern editing shortcuts:
117
118- B or <return>: toggle beat
119- N: toggle mask
120- <up>/<down>/<right>/<left>/<home>/<end> : move
121
122Feedback and Support
123====================
124
125Please give me some feedback. Tell me if Jackbeat inspires you.
126
127For user support, mailing list and bug reports please see:
128http://jackbeat.samalyse.org/wiki/UserSupport
129
130You may also send me links to your musical productions so that I can include
131them on the musical examples page at:
132http://jackbeat.samalyse.org/wiki/MusicExamples
133
134Contact
135=======
136
137Home page : http://jackbeat.samalyse.org
138
139Olivier Guilyardi <olivier {at} samalyse {dot} com>
140
141 
Note: See TracBrowser for help on using the browser.