ABOUT THIS RELEASE
------------------

As I didn't want to wait any longer - here you are. Because of my
limited resources, this version of WorkMan is 'release quality'
for the following Operating Environments only:

*) Linux. Any setup with Kernel 1.2 or better as well as libc5 or
   better should suffice. 

*) Solaris. Any release should do. You may also be interested in
   WorkMan's Solaris binary compatibility. See
   http://www.midwinter.com/workman/ for details.

*) FreeBSD/NetBSD. Version shouldn't make any difference.

The other platforms were not or only slightly changed in this release. Your
mileages may vary. If you need support for your platform approved, please
grab the current snapshot from the WorkMan homepage and report any
problems to the maintainer. Thanks!

While Building WorkMan, you may encounter some warnings about unused
variables. Please note that these variables are holding the CVS/RCS id
for the particular source file. It is in no way a problem that these
variables are not used.

I tested this release under Solaris 2.6/SPARC using egcs-1.1.1 and
gcc-2.7.2.1. The Linux version was tested using egcs-1.1.2 (glibc2) and
is used everyday on my own libc5 based system (gcc-2.95).

All issues since the last public beta are addressed (I hope so! Please
bug me if I forgot something).

ABOUT THE MAKEFILES (and Compiler)
----------------------------------

Please try to use "Makefile". This assumes gcc being used. The makefile
was successfully used on the platforms mentioned above.
The version of shouldn't matter. I've used gcc-2.7.2.3, 2.8.x, egcs-1.1.1
and gcc-2.95 for building various WorkMan binaries.
The only other makefile compatible with this version of WorkMan is
"Makefile.sun". The other makefiles are just there for reviewing...
In these days, people tend to tell people about the sizes of the
binaries using different compilers. Here you are:

compiler	after "make"	stripped
------------------------------------------------
gcc-2.7.2.3	567k		92k
egcs-1.1.1	395k		98k
gcc-2.95	363k		92k

These sizes are taken from an i586-pc-linux-gnulibc1 system.
Please note that my gcc-2.95 uses AMD k6 optimization by default.

CONFIGURATION
-------------

Some aspects of WorkMan are only configurable via compile time
definition. Please review the section for your platform in the
file config.h for options.


INTRODUCTION
------------

WorkMan is a graphical tool for playing audio compact discs on a CD-ROM
drive.  It has most of the features available on standalone CD players,
such as a shuffle mode, programmable playlists, and elapsed/remaining
timers.  But it also has extra features, foremost of which is the ability
to store information about CDs in a database, then automatically extract
that information when the CD is inserted later.  WorkMan stores the
artist's name, the disc title, the names of individual tracks, and even
remembers which tracks you don't want to hear!  All in an easy-to-use,
attractive OPEN LOOK graphical interface.


WHAT NOW?
---------

Much of WorkMan's documentation, including the installation instructions,
is in HTML (Hypertext Markup Language) format, suitable for viewing with
your favorite WWW browser.  The files are all in the "HTML" subdirectory.
If you're using Netscape, for instance, type

	netscape file:`pwd`/HTML/index.html

(those are backquotes, not regular single quotes!) to get to the main menu,
or open the index document in a browser that's already running.  You
shouldn't have to put the docs on an HTTP server; the "file:" URL lets you
get at files on the local filesystem.  You might have to put "//localhost"
before the local path, just after the colon.

If you don't have a Web browser handy, text-only copies of the HTML files
are in the "DOCS" directory.  See "install" and the "notes" file for your
specific platform for installation instructions.

The manual page (workman.man) contains a brief description of the user
interface, though for the most part you should be able to start using
the tool right away without reading the docs.  The workmandb.man manual
page describes the database file format.

LICENCING INFORMATION
---------------------

For information on WorkMan copying policy, read the file COPYING. This
file contains the GNU GPL version 2. You may have guessed it: WorkMan's
copying policy is GNU GPL v2.


WORKBONE
--------

On most systems, the included WorkBone target should also build and
work. However, this is just a gimmick for those who dare to play around
with the sources... I know that WorkBone's interface at least works for
Linux and is stable.

--
$Id: README,v 1.8 1999/10/27 05:48:05 dirk Exp $
