=======================================================================
*** ecamegapedal - README                                           ***
=======================================================================
-----------------------------------------------------------------------
 What is it?
-----------------------------------------------------------------------

Ecamegapedal is a realtime effect processor built on top 
of ecasound and Qt packages. It's meant to be used as 
a virtual guitar-fx or studio effect box. In addition to 
realtime operation, ecamegapedal also supports reading from
and writing to audio files. All audio file formats and effect 
algorithms provided by the ecasound libraries are supported. 
This includes OSS, ALSA and aRts support, over 20 file formats, 
over 30 effect types, LADSPA plugins and multi-operator effect 
presets.

-----------------------------------------------------------------------
 Requirements
-----------------------------------------------------------------------

To run ecamegapedal, you need...:

- POSIX compliant UNIX system; tested with Linux 2.2.x and 2.4.x, glibc 2.1.x
- POSIX threads; tested with linuxthreads 0.7 (libpthread, comes with glibc)
- ecasound libraries
- qt 2.x runtime libraries

To compile ecamegapedal, you also need...:

- standard C++ build environment; tested with gcc 2.91.66 and 2.95.2
  (STL and exceptions need to be supported)
- GNU make, automake and autoconf packages
- qt 2.x development environment

-----------------------------------------------------------------------
 Installing
-----------------------------------------------------------------------

First of all, you should first try to use the binary-rpm release.
It's probably the easiest and the most straigthforward way to 
install this software. 

If you need to compile ecamegapedal, the file 'INSTALL' contains detailed 
instructions. To compile from rpm source packages, "rpm --rebuild 
ecamegapedal-x.y.xRt.src.rpm".

-----------------------------------------------------------------------
 Documentation
-----------------------------------------------------------------------

There's not much documentation available, but this shouldn't matter
much as ecamegapedal is quite straightforward and easy to use. 
Ecamegapedal documentation is updated whenever new features are added 
or old features have been modified. Some things are not documented
in great detail, but on the other hand, all documentation is kept
up-to-date.

- ecasound documentation
- ecamegapedal(1) man page
- command line help (ecamegapedal --help)

-----------------------------------------------------------------------
 Ecasound mailing lists
-----------------------------------------------------------------------

ecasound-announce@wakkanet.fi:
	A read-only list for announcements concerning
	ecasound and ecawave.

ecasound-list@wakkanet.fi:
	A general discussion forum for ecasound/ecawave
	developers and users. Announcements of new versions, bug warnings, etc 
	will be posted to this list. If you have problems compiling,
	installing or using ecasound apps, this is a good place to ask for
	help. Reports of working software/hardware combinations are also welcome.
	You can browse the message archives at
	http://www.wakkanet.fi/~kaiv/ecasound/ecasound-list/current/ 

You can join the lists by sending subscribe message to
majordomo@wakkanet.fi. You can also join using the following 
web front-end: http://eca.cx/mlists.html

-----------------------------------------------------------------------
 Web sites
-----------------------------------------------------------------------

Ecasound and ecamegapedal home site
- http://www.eca.cx

Distribution packages
- http://ecasound.seul.org/download/

Sculpscape, music recorded and mixed with ecasound
- http://www.wakkanet.fi/sculpscape/

-----------------------------------------------------------------------
 About free software development
-----------------------------------------------------------------------

You should always keep in mind, that development of free software
doesn't work in the same way as commercial development. Every
succesful free software project has an active userbase behind it. This
means that your comments, ideas and bug reports are extremely
important. If something doesn't work, or some feature is missing,
please mail me about it. Thank you in advance! You can send ecasound
related mails to me at mailto:k@eca.cx. If you want to see/hear 
ecasound in action, you can listen to some of my material at 
Sculpscape. All the newer ones are recorded and mixed with ecasound!

-----------------------------------------------------------------------
 Stable and development versions
-----------------------------------------------------------------------

Although publically released versions are called stable, this is not 
a guarantee of any kind. I use a small test-bench to check that all 
essential features are working and I use these versions myself, but 
that's it. And note that this isn't a temporary solution. As ecasound 
is open-source software, it will become more stable as more people 
start using it and bugs are found. So join the fun! :) 
	 
-----------------------------------------------------------------------
 Author 
-----------------------------------------------------------------------

Kai Vehmanen -	mailto:kaiv@wakkanet.fi
		http://www.wakkanet.fi/~kaiv

-----------------------------------------------------------------------
 Contributors / credits / thanks to 
-----------------------------------------------------------------------

Ritscher, Meinhard - Author of KCorrMeter from which ecamegapedal's
		     VU-meter code originates [mritscher]

all LAD members - always a great source of inspiration
www.niccx.com - for eca.cx, ecasound.cx and ecawave.cx domains
SEUL - for hosting ftp, http and CVS sites
WakkaNet Oy - for hosting ecawave web site

-----------------------------------------------------------------------
 Licensing/distribution policy
-----------------------------------------------------------------------

Copyright (C) 2001 Kai Vehmanen

Ecamegapedal is freely distributable according to the terms of the 
GNU General Public License (see the file 'COPYING').

This program is distributed without any warranty. See the file 
'COPYING' for details. 

=======================================================================
