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


     This is the README.txt file for AmphetaDesk. Within, you'll
      find installation instructions (you're already 90% done).
        Further documentation is located in /docs/index.html
           If you have problems, email morbus@disobey.com.


Located Below:
--------------
 - Upgrade Notes
 - Windows (95, 98, 2000, ME, NT, XP) Installation
 - Macintosh (7.5 through 9.2.1, OS X) Installation
 - Linux and Mac OS X Source Installation


###############################################################################
# Upgrade Notes                                                               #
###############################################################################

Upgrading consists of moving two files into the new installation.

 1) Install AmphetaDesk in a different location than your current install.
    Optionally, you can install over your current installation directory,
    but you may want to back up the two files below before doing so.

 2) Your current channel subscriptions and settings are contained within:

      /path/to/current/amphetadesk/data/myChannels.opml
      /path/to/current/amphetadesk/data/mySettings.xml

 3) To upgrade, simply copy those two files into the /data/
    directory of your newly installed version of AmphetaDesk.


###############################################################################
# Windows (95, 98, 2000, ME, NT, XP) Installation                             #
###############################################################################

 1) Unarchive the .zip file into a directory of your choice.
 2) You should have a directory with some folders and "AmphetaDesk.exe".
 3) Doubleclick "AmphetaDesk.exe" to start the program.
 4) Optionally, put a shortcut to the .exe on the Desktop or Start Menu.

That's it! Upon doubleclicking "AmphetaDesk.exe", a small window will
appear stating that it is downloading various files. Shortly thereafter,
your browser will open and you'll be able to start using AmphetaDesk.
Whenever you wish to use AmphetaDesk, simply double click the .exe.


###############################################################################
# Macintosh (7.5 through 9.2.1, OS X) Installation                            #
###############################################################################

 1) Unarchive the .sit.hqx file (Classic) or the
    dmg.gz (OS X) into a directory of your choice.
 2) You should have a directory with some folders and "AmphetaDesk".
 3) Doubleclick "AmphetaDesk".

That's it! Upon doubleclicking "AmphetaDesk", a small window will appear
stating that it is downloading various files. A minute later, your
browser will open and you'll be able to use AmphetaDesk fully. Whenever
you wish to use AmphetaDesk, simply double click the application.


###############################################################################
# Linux and Mac OS X Source Installation                                      #
###############################################################################

            NOTE: AmphetaDesk is runnable on OS X without going
             through the instructions below. Simply double click
             the "AmphetaDesk" application (with the pill icon).


 1) Unarchive the .tar.gz file into a directory of your choice.
 2) You should have a directory with some folders and AmphetaDesk.pl.
 3) Install some modules from CPAN. To do so, run the below:
 
       perl -MCPAN -e shell

    If this is your first time using CPAN, you'll be asked some questions
    concerning your configuration. Most of the defaults are fine - these
    questions need to be correct to correctly download the modules you need.

    At the CPAN prompt, type the following and press <return>:

       install Bundle::LWP

    This will download and install a number of modules. Just sit tight
    and watch the output scroll by. Eventually, you'll be returned to
    the 'cpan>' prompt.


       #######################################################################
       # did errors occur above? if so, read below, else skip below.         #
       #######################################################################

       If the last few messages from the output of your command concern
       errors, or tell you that installation won't continue, then we'll
       need to force an install. Some sample errors are shown below:

           make[1]: *** [xmlwf] Error 1
           make: *** [xmlwf] Error 2
           Make had some problems, maybe interrupted? Won't install

       Generically speaking, forcing an install of CPAN modules is not a
       good idea, as it suggests something is wrong in the first place.
       If you're in a hurry, enter the following. If you're NOT in a
       hurry, then you should probably try to find out what the
       problem is. Enter the following at the CPAN prompt:
       
          force install Bundle::LWP

       #######################################################################
       # don't continue below until you've installed Bundle::LWP correctly.  #
       #######################################################################

    Now, we need to install expat, which is an XML parser. To do so,
    grab the latest version from http://expat.sourceforge.net/ and 
    follow the instructions within that archive. Once it's installed,
    we'll continue on with our installation.

       #######################################################################
       # don't continue below until you've installed expat correctly.        #
       #######################################################################

    Now, we're almost done. Load up CPAN again by entering:

       perl -MCPAN -e shell

    And type the following at the CPAN prompt:

       install XML::Parser

       #######################################################################
       # are you running Macintosh OS X? Read this, else, skip below.        #
       #######################################################################

       You must install XML::Parser manually, due to it not being able to
       find the expat library we just installed. To do so, download from
       http://www.cpan.org/authors/id/C/CO/COOPERCL/XML-Parser.2.31.tar.gz
       and extract to a directory of your choice. Within the shell, navigate
       to that directory and enter the following commands:

          # this first command is ALL ONE LINE.
          perl Makefile.PL EXPATLIBPATH=/usr/local/lib/
                           EXPATINCPATH=/usr/local/include/
          make
          make test 
          sudo make install

       #######################################################################
       # got XML::Parser installed? You're almost done!                      #
       #######################################################################

    At this point, all the necessary CPAN modules should be installed.

 4) Give AmphetaDesk execute permissions: "chmod 755 AmphetaDesk.pl"
 5) Once the modules are installed and permissions have been
    granted, you should be able to run either "AmphetaDesk.pl"
    or "./AmphetaDesk.pl" 


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