File	Date	Author	Commit
README	2012-10-27	Julian Marchant	[85e46a] Version 1.1.0 (initial commit)
gpl-3.0.txt	2012-10-27	Julian Marchant	[85e46a] Version 1.1.0 (initial commit)
icon.png	2012-10-27	Julian Marchant	[85e46a] Version 1.1.0 (initial commit)
stopwatch.py	2012-10-27	Julian Marchant	[b7494a] Set __version__ to 1.1.0

Read Me

Pandora Stopwatch
========================================================================

Simple stopwatch program in Python.  Works on the Pandora or any PC.


How to run
------------------------------------------------------------------------

On the Pandora, simply download the PND and run it as normal.

On a PC (e.g. GNU/Linux, Windows, or Mac OS X), make sure you have the
following installed:

    Python version 2.6 or later, but not Python 3
    Pygame 1.8 or later

You can then run stopwatch.py with Python as normal (usually by double-
clicking stopwatch.py or with a command such as "python stopwatch.py").

On UNIX and UNIX-like systems, such as GNU/Linux and BSD, you can also
run stopwatch.py as a program, assuming /usr/bin/env is available
and "python" is the Python binary on your system.  Some arguments are
available; see Command Line Arguments below for more information, or run
e.g. "python stopwatch.py --help".


Controls
------------------------------------------------------------------------

On the Pandora, the controls are:
    Start, Enter: start and stop the stopwatch
    (X), (Y), (L): record the current time
    (A), (B): press to start counting, release to stop counting
    Select, (R): Reset the stopwatch

On a normal keyboard, the controls are:
    Enter, Alt: start and stop the stopwatch
    Space, Shift: record the current time
    Up arrow: press to start counting, release to stop counting
    R, Ctrl: Reset the stopwatch


Usage Notes
------------------------------------------------------------------------

When the program is closed, all of the times you recorded will be
written to the file "records.out", which is a plain text file.  On the
Pandora, this file will be found in pandora/appdata/stopwatch.  On a PC,
it will be found in the same directory as the program.  You can change
which file is written to with the --output argument.

The stopwatch normally uses a timing method which gives the CPU a
break, but may not be perfectly accurate.  For the best possible
accuracy, use the --accurate argument when running the program, or
choose the "high accuracy" stopwatch icon on the Pandora. Note that, in
this mode, Pandora Stopwatch will use all CPU time. Also note that the
difference in accuracy is small, so you probably won't even notice it.

On the Pandora, if you wish to use different command line options, such
as a different frame rate, create a shell script file called "run.sh"
which does what you want.  Note that Stopwatch should be executed in the
form "python stopwatch.py [options]" or "./stopwatch.py [options]",
replacing [options] with an argument or set of arguments from the
Command Line Arguments section below.


Command Line Arguments
------------------------------------------------------------------------

  -a, --accurate               Run in "accurate" mode, which is more
                                 precise, but uses more CPU time.
  -f FPS, --fps=FPS            Run at frame rate FPS instead of the
                                 default 120 frames per second.  Has no
                                 effect if --accurate is given.
  -h, --help                   Show this help screen.
  -o FILE, --output=FILE       Set the file to write the records to.