README for Palm Fuel Log version 0.97

Sunday, October 7, 2001



What is Palm Fuel Log?
------------------------------

Palm Fuel Log is an open source program for the Palm that allows you to
record petrol purchases. It then computes a series of statistics relating
to fuel consumption for each vehicle. The statistics include fuel cost/mile,
miles per gallon, litres per 100km, etc.

The program was originally created by David Angier. It provides many
powerful features. You can visit its home page on Sourceforge at
http://sourceforge.net/projects/palmfuellog/

Palm Fuel Log is distributed under the GNU General Public License v2. See the
file COPYING for the text of the GPL.


Requirements
------------------------------
* Palm OS 2.0 or better
* 512K of memory


Quick Usage
------------------------------
1) Put fuellog.prc onto your Palm.
2) Enter data and enjoy!
3) We would really like to hear feedback. You can
   report bugs on the Sourceforge site at
   http://sourceforge.net/tracker/?group_id=33654&atid=408818


Features
------------------------------
  * Multiple categories to filter cars shown
  * Individual fuel record statistics
  * Overall and average fuel record statistics
  * Graph charting computed average, individual fuel records, and
    exponentially smoothed moving average
  * Notes for each record
  * Odometer readings in miles or kilometers
  * Fuel volume readings in US gallons, gallons or litres
  * Fuel efficiency readings in Miles/Gallon, Litres/100Km, and Kms/Litre
  * Export the records to the Memo Pad
  * Date filtering
  * Completely 100% Free (licensed under the GPL 2.0)


Working with the Source
------------------------------
You'll need a suitable Palm developement environment. Palm Fuel Log is currently
compiled using GCC and Palm SDK 4.0, so you will need a copy of them. It was
originally developed in CodeWarrior, but the resources for CodeWarrior are no
longer maintained. You will need to use the Pilrc plugin to CodeWarrior if you
plan to use that as your development environment.

You should look in the Makefile to make sure the program names and paths are
okay.
  "make"
You should now have fuellog.prc.

If you plan to help with development of Palm Fuel Log please use the latest copy
from CVS. It can be found at:
  http://sourceforge.net/projects/palmfuellog/
