###############################################################################
# AmphetaDesk                                           (c) 2000-2002 Disobey #
# README.txt                              http://www.disobey.com/amphetadesk/ #
###############################################################################


     This is the README.txt file for the lib/ directory of AmphetaDesk.


###############################################################################
# About the AmphetaDesk lib/ Directory.                                      #
###############################################################################

The lib/ directory contains all the various Perl modules that are
necessary for AmphetaDesk to work. Any fiddling with the stuff in here
could cause your AmphetaDesk to no longer operate correctly. On the
other hand, if you know Perl, you can customize AmphetaDesk to your
bidding any which way.

  AmphetaDesk/
   The various modules within are the flesh of AmphetaDesk. These Perl
   modules control everything from channel display and downloading, to
   the routines that create and interact with the GUI for your operating
   system (within AmphetaDesk/OS/). If you know Perl (and only if you
   know Perl), more documentation awaits you within each file.

  Text/
   Contains the Perl module Text::Template from Mark-Jason Dominus. This
   module handles all the template capabilities of AmphetaDesk (and is
   called from AmphetaDesk.pm, below).

  XML/
   Contains the Perl module XML::Simple from Grant McLean. This module
   handles all our XML parsing, and depends on XML::Parser (which
   requires the C library expat). XML::Parser and expat should be
   compiled into the wrapper binary on Mac/Win - otherwise, you'll need
   them installed to use most Perl XML modules.

  AmphetaDesk.pm
   The launch pad for everything that AmphetaDesk does. This module sets
   up the environment for AmphetaDesk (loading settings, configuring the
   webserver, starting the infinite loop, handling the template display,
   etc.). It uses all the files from AmphetaDesk/ (above).

###############################################################################
#              Further documentation lives in docs/index.html.                #
###############################################################################
