$Id: README,v 1.4 2001/09/03 19:05:10 rogue Exp $

This is the README file for Xforge, a Motif wave editor. Please read the
file LICENSE for licensing information, and INSTALL for information on how
to install Xforge.

1.  What is Xforge?

Xforge is a graphical wave editor for UNIX systems with X11 and Motif.
The name is derived from popular PC/Windows wave editor Sound Forge, and
the goal of Xforge project is to provide similar wave editing facilities
to UNIX world, but as free software.

Though Xforge supports multiple wave formats, it is not a wave format
converter; there exists a wonderful utility called Sox for that purpose.
You will find that Xforge supports very few wave formats at the moment.
Are you interested in coding decoders / encoders for your favourite file
formats?

Xforge was written by Xforge project. Currently, that is:
Pekka Honkanen <phonkane@cc.hut.fi>
Xforge has nothing to do with Helsinki University of Technology.

Note that Xforge is not public domain; read the file LICENSE for licensing
details.

2.  Supported machines

Xforge development is currently done with Alpha Linux (SuSE 6.3) machine,
and thus Xforge should work pretty well in Linux machines in general.
Also, Xforge is known to work with following machines:

	o HP-UX 10.20 (HP K360)
	o NetBSD 1.4.2 (Sun Sparcstation 1+)
	o SunOS 5.8 (Sun Ultra 60, gcc)

Xforge used to work on following platforms (but has not been tested lately):

	o AIX 4.3.1.0 (rs6000)
	o Digital Unix 4.0D (DEC PWS433au)
	o FreeBSD 2.2.6-RELEASE (i386)
	o IRIX 6.3 (SGI O2)
	o Solaris 2.6 (sparc)
	o Unixware 7.0.1 (i386)

For audio output, you need OSS compatible audio drivers. Are you interested
in porting Xforge?

Xforge requires X11R5 and Motif - Lesstif will also work (versions 0.83,
0.85 and 0.88.9 at least). For audio playback, OSS drivers are required
(they exist at least on Unixware, and Linux kernel includes the free
version). You will also want plenty of memory for editing large files,
since Xforge currently operates only in core. Data is handled in floating
point values, with buffer specific undo buffers, so you can account for much
more memory than the wave consumes disk space.

Xforge is made of C, so a C compiler is of course required unless you can
find someone who can provide you a binary. The Xforge project won't.

3.  Acquiring Xforge

Currently, Xforge can be acquired from following URL:

http://www.hut.fi/~phonkane/xforge/

4.  Bugs

Certainly many. I try to keep some quality in releases... With Lesstif,
you are likely to have problems (versions since OpenMotif became open
source have not been tried).

Have you found a bug? Come on, tell it to me. Otherwise it may never get
fixed. Don't send me core dumps however - I can't do anything with them
and I find large emails annoying. Much more informal is a description of
how to reproduce the behaviour you consider a bug, the machine details,
etc. You are free to fix the bug, too, and send me the diffs if you get
really excited :-)

Bug reports, suggestions etc. should go to author, Pekka Honkanen:

phonkane@cc.hut.fi
