root/sweep/branches/sweep-jack-testing/README

SWEEP, a sound wave editor, brought to you by Conrad Parker
-----------------------------------------------------------

Sweep is an audio editor and live playback tool for GNU/Linux, BSD and
compatible systems. It supports many music and voice formats including
WAV, AIFF, Ogg Vorbis, Speex and MP3, with multichannel editing and
LADSPA effects plugins. Inside lives a pesky little virtual stylus called
Scrubby who enjoys mixing around in your files.

Sweep is designed to be intuitive and to give you full control. It includes
almost everything you would expect in a sound editor, and then some:

        * precise, vinyl like scrubbing
        * looped, reverse, and pitch-controlled playback
        * playback mixing of unlimited independent tracks
        * monitoring support for use with multiple audio devices
        * looped and reverse recording
        * internationalisation
        * multichannel and 32 bit floating point file support
        * Ogg Vorbis, MP3 and Speex compressed formats
        * sample rate conversion and channel operations
        * LADSPA 1.1 effects support
        * multiple views, discontinuous selections
        * easy keybindings, mouse wheel zooming
        * unlimited undo/redo with fully revertible edit history
        * multithreaded background processing
        * shaded peak/mean waveform rendering, multiple colour schemes


Summary of library dependencies:
--------------------------------

REQUIRED:

        * GTK+ 2.0, (version 2.4.0 or higher) standard in most 
          distributions and available from:

            http://www.gtk.org/

        * libsndfile-1.0.x, available from:

            http://www.zip.com.au/~erikd/libsndfile/

        * Secret Rabbit Code, aka. libsamplerate, available from:

            http://www.mega-nerd.com/SRC/
        
OPTIONAL:

        * Ogg Vorbis libraries (high quality perceptual audio format):

            http://www.vorbis.com/

        * libmad (MPEG audio loading), available from:

            http://www.underbit.com/products/mad/       
        
        * Speex library (an open speech compression format):

            http://www.speex.org/

See the file INSTALL for building instructions. Generally all that is
required, after the above libraries have been installed, is:

        ./configure
        make
        make install

If you are not sure what you need, simply run ./configure and it will probe
your system and provide a reasonably useful summary.

For information on enabling and disabling optional components, run
./configure --help

Homepage
--------

Detailed information and new releases of Sweep can be found at:

        http://sweep.sourceforge.net/

Mailing Lists
-------------

There are four mailing lists related to sweep:

sweep-announce
        which contains only announcements about new releases of sweep.
This is a moderated list. 

sweep-users
        For general discussion about using sweep

sweep-devel
        For discussion about sweep development related issues. 

sweep-i18n
        For discussion of language translation issues.

Archives of each list are available on the World Wide Web via the
Sweep homepage. You can also subscribe or unsubscribe via a web
interface.

For more information about using these lists or to subscribe or
unsubscribe via an email interface, send a message with just the word
`help' as subject or in the body, to:

        sweep-announce-request@lists.sourceforge.net
  or
        sweep-users-request@lists.sourceforge.net
  or
        sweep-devel-request@lists.sourceforge.net
  or
        sweep-i18n-request@lists.sourceforge.net

as appropriate.

Internet Relay Chat
-------------------

For usage and developer discussion, join the channel #sweep on
irc.freenode.net (established 2005).

Licence
-------

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
USA.

Acknowledgements
----------------

Thanks to Pixar Animation Studios and CSIRO Australia for supporting
the development of this project.

Contact
-------

If you have any further queries about Sweep, please contact the main
author:

Conrad Parker <conrad@vergenet.net>