root/trunk/README

Revision 653, 4.0 kB (checked in by olivier, 10 months ago)

fix readme rest formatting

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