
==================
Installing Plucker
==================

Basically there are only a few simple steps to get this running for yourself.
First check the file REQUIREMENTS to make sure you have the tools required to
run Plucker. Then depending on the OS you use do the following:

-----------
Unix/Linux:
-----------
  for more info see README files underneath the parser directory for 
  their individual usage and parameters.

  1. You set up your environment and install the viewer application
     by running 'install-plucker' in the unix directory. This will 
     create a few quick paths and install the parser, the Palm apps 
     and the default configuration files. In the source package it
     will first build all the different parts of Plucker (see the 
     README file in the viewer dir for more instructions about how
     to build the viewer and shared library). In the binary package 
     all these files are already included and the script will just 
     install them.

  2. Edit and change the home page (which links to all other pages)
     by changing the ~/.plucker/home.html file. You can of course edit 
     the other files too. You can also edit .pluckerrc, to set up the
     default behavior of the python parser.

  3. Run 'plucker-build' to download the web pages. 

-----
OS/2:
-----
  for more info see README.OS2.

  1. You set up your environment and install the viewer application
     by running:

     install_os2 <path> <port>

     <path> represents the path to which you want to install
            the plucker package.
            e.g. E:\PalmPilot\Plucker

     <port> represents the COM-Port you Palm is connected to.
            If no port is specified COM1 is assumed by default.
            e.g. COM1

  2. After creating a suitable HOME.HTML (found in $Home\.plucker) you 
     may want to retrieve the data. Open a connection to the internet 
     using OS/2's dial-function, and simply start "Plucker Hotsync". 
     If your environment is set up correctly Plucker starts to retrieve 
     the pages you mentioned in HOME.HTML.

  NOTE: Maybe you'll need to set HOME-environment-variable in your CONFIG.SYS
  prior to calling install_os2. To do this simply add a line like

  SET HOME=F:/home

  and create the directory F:/home by

  F:
  md home

  if you want to place your HOME on drive F: If you already use Unix-style
  software (GNU-tools, XFree86/2 etc.) this variable may be already set.
  If you've any problems with this stuff, feel free to mailto:a.wagner@teamos2.de.
  (You may also use write in German)

--------
Windows:
--------

  On Windows we encurage you to use the graphical installer we provide. It will
  take care about all steps necessary to set up Plucker correctly.
  
  The following steps are necessary to get Plucker running on Windows using
  this installer:

   * Download the Installer package for Windows from our web page and run it.
   * Follow the on-screen instructions.



==========================================================================
See the FAQ for more information, including email addresses and web pages.
==========================================================================

Have fun! And if you feel like helping out, then please contact
plucker-dev@rubberchicken.org to avoid duplicating any work.
