root/tags/release-0.7.3/README

Revision 617, 4.0 kB (checked in by olivier, 9 months ago)

add note about win32 build in readme

  • Property svn:eol-style set to native
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
61For Windows please see:
62http://jackbeat.samalyse.org/browser/trunk/mingw/README
63
64Developer/maintainer mode
65=========================
66
67If you want to compile Jackbeat and run it without installation, you
68need to::
69
70    ./configure --enable-devmode
71    make
72    # run jackbeat from the current directory:
73    src/jackbeat
74
75Usage
76=====
77
78Jackbeat is pretty simple to use. Browse through the main menu, it is meant to
79be quite obvious. The Sequence and Track buttons at the bottom of the window
80open the corresponding properties panel where you'll find convenient functions.
81
82To begin, just a load a few samples using the track panel properties or the edit menu.
83Then by toggling some of the buttons on the drummachine and clicking Play you shall
84hear some music. Well... hopefully ;)
85
86Notes about export parameters
87~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88
89When you export the current sequence as a WAV file, you are given a choice
90about how to handle samples that continue playing passed the end of the sequence:
91
92  - loop: mix at the beginning. This is optimal for playing the exported
93    WAV file as a loop in some external software.
94  - truncate: don't play at all. This will sound like the initial sequence
95    playback, before it has looped at least once.
96  - keep: continue playing samples until they terminate. Beware that the
97    exported file may thus be (much) longer than the sequence.
98
99The double function
100~~~~~~~~~~~~~~~~~~~
101
102Available in the Edit menu, Double increases the beats number by a factor of 2,
103and duplicates the beats data. This feature allows you to increase your workspace
104size, while keeping the output unchanged.
105
106About track masking
107~~~~~~~~~~~~~~~~~~~
108
109Track masks allow you to insert silences into a track interactively.
110 
111Use Shift-Click (or press N) to toggle the mask for a given beat. The corresponding track
112will then get muted during the duration of that beat.
113
114Keyboard shortcuts
115~~~~~~~~~~~~~~~~~~
116
117You can learn about most of the keyboard shortcuts by looking at the main menu.
118
119There also are a few pattern editing shortcuts:
120
121- B or <return>: toggle beat
122- N: toggle mask
123- <up>/<down>/<right>/<left>/<home>/<end> : move
124
125Feedback and Support
126====================
127
128Please give me some feedback. Tell me if Jackbeat inspires you.
129
130For user support, mailing list and bug reports please see:
131http://jackbeat.samalyse.org/wiki/UserSupport
132
133You may also send me links to your musical productions so that I can include
134them on the musical examples page at:
135http://jackbeat.samalyse.org/wiki/MusicExamples
136
137Contact
138=======
139
140Home page : http://jackbeat.samalyse.org
141
142Olivier Guilyardi <olivier {at} samalyse {dot} com>
143
144 
Note: See TracBrowser for help on using the browser.