README.txt: Awesum - http://awesum.sf.net/
Copyright (c) 2004, Darren L. LaChausse
the_trapper@users.sourceforge.net
==========================================

ABOUT:
~~~~~
Awesum is an easy to use graphical checksum verification utility.  It is 
written in Python and uses the PyGTK toolkit.

LICENSE:
~~~~~~~
This software is licensed under the terms of the BSD License.  Please refer to
the file 'LICENSE.txt' for more information.  By using this software package, 
you agree to abide by the terms set forth in the license agreement contained in
the file 'LICENSE.txt'.

SUPPORTED PLATFORMS:
~~~~~~~~~~~~~~~~~~~
Awesum was developed on Linux (Fedora Core 1), but should work on any platform
supported by Python and PyGTK with little or no modification required.

INSTALLATION:
~~~~~~~~~~~~
Since Awesum is a simple program consisting of a single Python script 
(awesum.py) no installation is necessary.  See the next section of this README 
or the appropriate section of the User's Guide for more information on getting 
started with Awesum.

QUICK START:
~~~~~~~~~~~
If you are impatient or don't feel like reading the User's Guide for this
software, this section is for you!

For Fedora Core and other RPM-based distributions:

 1.) Download the binary RPM distribution of Awesum.  It will be a file of
     the form 'awesum-x.y.z-n.noarch.rpm'.

 2.) Install the RPM package you just downloaded using the following command:

          $ rpm -Uvh awesum-x.y.z-n.noarch.rpm

     NOTE: The '$' symbol in the command lines above is a typical UNIX command
           prompt and should not be typed as part of the commands.  Also, be
           sure to replace the x.y.z portion of the file name with the actual
           version number for Awesum.

 3.) The RPM package integrates Awesum into the system by adding it to your
     path.  To run Awesum, simply type the following command:

          $ awesum

For other flavors of Linux and UNIX-like systems:

 1.) Download the tarball distribution of Awesum.  It will be a file of the
     form 'awesum-x.y.z-src.tar.gz'.

 2.) Unpack the tarball distribution.  One of the following commands should be
     sufficient:

          $ tar zxvf awesum-x.y.z-src.tar.gz

                        -or-

          $ gunzip -c awesum.tar.gz | tar xvf -

     NOTE: The '$' symbol in the command lines above is a typical UNIX command
           prompt and should not be typed as part of the commands.  Also, be
           sure to replace the x.y.z portion of the file name with the actual
           version number for Awesum.

 3.) Make sure you have a recent version of Python and PyGTK installed.  

     Python is available from http://www.python.org/ if it is not already
     installed on your system.

     PyGTK is available from http://www.pygtk.org/

 4.) Run the 'awesum.py' Python script from the directory you unpacked the
     Awesum distribution to in step 2.

     This may be acheived in two ways.  Firstly, 'awesum.py' is an executable
     shell script, meaning that you may run it directly using the following
     command:

          $ ./awesum.py

     The second method is to invoke the Python interpreter like so:

          $ python awesum.py

CHANGES:
~~~~~~~
Awesum is now available as an RPM package.

BUGS:
~~~~
There are no known bugs in Awesum at the time of release.  However, if in the
somewhat likely event that you do encounter a bug in this software, please 
report it to the author.  (See the top of this file for the appropriate contact 
information.) Be sure to include all relevant information required to reproduce 
the error, such as the operating system and the versions of Awesum, Python, and 
PyGTK involved.  Messages such as "Your piece of crap software doesn't work"
or "Fix the 'Go!' button" are not sufficient bug reports.

THANK YOU:
~~~~~~~~~
Thank you very much for trying this software.  If you like it, please be sure
to let me know.  I am always interested in any comments you may have regarding
this software, good or bad.

Sincerely,
Darren L. LaChausse - the_trapper@users.sourceforge.net
