Write README.md for release v1.0

README.md

@@ -0,0 +1,85 @@
+IceTimer
+========
+
+IceTimer is a graphical timer and match scheduler for round-robin style
+informal tournaments. Primarily intended for use in Oxford University
+Alternative Ice Hockey sessions but could easily be modified for use in other
+situations.
+
+
+Installation
+------------
+
+Binaries and installation instructions for Windows and Mac OS X are available
+on [SourceForge](https://sourceforge.net/projects/icetimer/).
+
+
+Compilation
+-----------
+
+If there is no binary available for your system then you can compile IceTimer
+from its source files using the Processing IDE, the latest version of which
+can be downloaded from <http://processing.org/download/>.
+
+Make sure that all of the .pde files and the data folder are together within
+the same parent folder - this should already be the case if you have
+downloaded and extracted the IceTimer-1.0-Source.zip archive. Use the IDE to
+open the file IceTimer.pde and choose 'Sketch' > 'Run' from the menu to check
+that everything is working. You can then export an application for your system
+by choosing 'File' > 'Export Application'.
+
+You can also compile IceTimer directly from its Java source file but you will
+need to install the Processing library to be able to do this.
+
+
+Documentation
+-------------
+
+Use the controls at the top of the program interface to enter session details
+and press 'START' to begin. The background will turn amber to warn when there
+are 15 minutes left in the session and red when there are 5 minutes left. You
+can end the session by pressing 'END' in order to change the session details
+(e.g. if more teams arrive).
+
+The current game is highlighted in the match list and will respond to presses
+of the play/pause and skip/end button controls, the latter of which advance
+the current game to the next game in the match list. The highlight will change
+colour to indicate when there are 30 seconds and 10 seconds left in the
+current game.
+
+When the timer reaches zero, the current game will automatically be advanced
+but the clock for the next game will not start until the play button is
+pressed; this gives time for the new teams to be read out. You can also use
+the spacebar instead of the play/pause button.
+
+The match list will slowly scroll up the screen as games are played. The
+horizontal bars indicate the current position in the list and within the
+current game, so it should be easy to tell the teams who will be on next from
+those who are on now.
+
+
+Credits
+-------
+
+Match fixture lists generated using Jonathan Rennison’s [Match Fixture List
+Generator](https://sourceforge.net/projects/matchgen/).
+Program typeface is Squarish Sans CT by Tim Larson.
+IceTimer is written in Java using [Processing](https://processing.org/).
+
+
+License
+-------
+
+Copyright (C) 2014 Joe Cridge.
+
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See LICENSE.txt.
+
+Joe Cridge, July 2014.
+<mailto:[email protected]>