1
2SWEEP, a sound wave editor, brought to you by Conrad Parker
3-----------------------------------------------------------
4
5Sweep is an audio editor and live playback tool for GNU/Linux, BSD and
6compatible systems. It supports many music and voice formats including
7WAV, AIFF, Ogg Vorbis, Speex and MP3, with multichannel editing and
8LADSPA effects plugins. Inside lives a pesky little virtual stylus called
9Scrubby who enjoys mixing around in your files.
10
11Sweep is designed to be intuitive and to give you full control. It includes
12almost everything you would expect in a sound editor, and then some:
13
14        * precise, vinyl like scrubbing
15        * looped, reverse, and pitch-controlled playback
16        * playback mixing of unlimited independent tracks
17	* monitoring support for use with multiple audio devices
18        * looped and reverse recording
19        * internationalisation
20        * multichannel and 32 bit floating point file support
21	* Ogg Vorbis, MP3 and Speex compressed formats
22	* sample rate conversion and channel operations
23        * LADSPA 1.1 effects support
24        * multiple views, discontinuous selections
25        * easy keybindings, mouse wheel zooming
26        * unlimited undo/redo with fully revertible edit history
27        * multithreaded background processing
28        * shaded peak/mean waveform rendering, multiple colour schemes
29
30
31Summary of library dependencies:
32--------------------------------
33
34REQUIRED:
35
36        * GTK+ 2.0, (version 2.4.0 or higher) standard in most
37	  distributions and available from:
38
39	    http://www.gtk.org/
40
41        * libsndfile-1.0.x, available from:
42
43            http://www.zip.com.au/~erikd/libsndfile/
44
45	* Secret Rabbit Code, aka. libsamplerate, available from:
46
47	    http://www.mega-nerd.com/SRC/
48
49OPTIONAL:
50
51	* Ogg Vorbis libraries (high quality perceptual audio format):
52
53	    http://www.vorbis.com/
54
55	* libmad (MPEG audio loading), available from:
56
57	    http://www.underbit.com/products/mad/
58
59 	* Speex library (an open speech compression format):
60
61	    http://www.speex.org/
62
63See the file INSTALL for building instructions. Generally all that is
64required, after the above libraries have been installed, is:
65
66	./configure
67	make
68	make install
69
70If you are not sure what you need, simply run ./configure and it will probe
71your system and provide a reasonably useful summary.
72
73For information on enabling and disabling optional components, run
74./configure --help
75
76Homepage
77--------
78
79Detailed information and new releases of Sweep can be found at:
80
81        http://sweep.sourceforge.net/
82
83Mailing Lists
84-------------
85
86There are four mailing lists related to sweep:
87
88sweep-announce
89        which contains only announcements about new releases of sweep.
90This is a moderated list.
91
92sweep-users
93	For general discussion about using sweep
94
95sweep-devel
96        For discussion about sweep development related issues.
97
98sweep-i18n
99	For discussion of language translation issues.
100
101Archives of each list are available on the World Wide Web via the
102Sweep homepage. You can also subscribe or unsubscribe via a web
103interface.
104
105For more information about using these lists or to subscribe or
106unsubscribe via an email interface, send a message with just the word
107`help' as subject or in the body, to:
108
109        sweep-announce-request@lists.sourceforge.net
110  or
111        sweep-users-request@lists.sourceforge.net
112  or
113        sweep-devel-request@lists.sourceforge.net
114  or
115	sweep-i18n-request@lists.sourceforge.net
116
117as appropriate.
118
119Internet Relay Chat
120-------------------
121
122For usage and developer discussion, join the channel #sweep on
123irc.freenode.net (established 2005).
124
125Licence
126-------
127
128This program is free software; you can redistribute it and/or modify
129it under the terms of the GNU General Public License as published by
130the Free Software Foundation; either version 2 of the License, or
131(at your option) any later version.
132
133This program is distributed in the hope that it will be useful,
134but WITHOUT ANY WARRANTY; without even the implied warranty of
135MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
136GNU General Public License for more details.
137
138You should have received a copy of the GNU General Public License
139along with this program; if not, write to the Free Software
140Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
141USA.
142
143Acknowledgements
144----------------
145
146Thanks to Pixar Animation Studios and CSIRO Australia for supporting
147the development of this project.
148
149Contact
150-------
151
152If you have any further queries about Sweep, please contact the main
153author:
154
155Conrad Parker <conrad@vergenet.net>
156