
NO WARRANTY - WARNING!
----------------------
This software is supplied free of charge under the terms of the GNU GPL;
see the file "COPYING" for details. BE WARNED that while I hope this 
software works properly, it comes with NO WARRANTY. Use it only if
you'll accept personal responsibility for the loss of all the data in
your pilot, should plucker fail.


INTRODUCTION
------------
This README talks about how to compile the viewer for Plucker, a free
(GPL) offline HTML reader for the Palm Computing Platform.


UPGRADE
-------
Please be aware that PluckerDB files from earlier versions of Plucker won't
work in this version.


TOOLS
-----
The source code requires the SDK for PalmOS 3.5 to compile, but 
the binary will run on all PalmOS 3.x and PalmOS 2.0.3 devices. 

To build the shared library the zlib package (zlib-1.1.3.tar.gz) 
must be available in the ZLib directory.

When running configure you should use the --enable-palmos if you 
are using prc-tools-2.0 and --enable-palmos-coff it you are using 
prc-tools-0.6.0beta.


LANGUAGE SUPPORT
----------------
See the file langs/TRANSLATING for adding support of other languages.


COMPILING
---------
There's nothing clever about compiling. First make sure that the zlib
source package is available in the ZLib directory. 

After running './configure' in the top directory you can either run 
'make prc-files' from that directory or just enter the viewer directory 
and type 'make' to build the PRC files, i.e. if you are running a Linux 
system. It should work just fine on Unix systems using GNU's make. Other 
platforms would probably require some changes to the Makefile and scripts.

Setting COLOR to yes (or use --enable-color when running configure) will 
build the color version. At the moment, this only gives you a different
application icon for the viewer, all the toolbar icons will still be
black and white.

By including the DEBUG flag you will get debug info written to the serial 
port. By adding calls to the macros MSG, MSG_IF, FATAL and FATAL_IF in the 
code you can output any kind of info you might need. When compiling without 
this flag all such calls are excluded from the resulting binary.

The flag ERROR_CHECK_LEVEL decides if the ErrDisplay macros should be 
included or not. All development binaries are compiled with ERROR_CHECK_FULL, 
i.e. all macros are included. You can change this in the Makefile to either 
ERROR_CHECK_PARTIAL or ERROR_CHECK_NONE.
