Read Me

==================
FragTimer v0.1.2
==================

FragTimer is a cross-platform mini application featuring multiple countdown
timers and/or stopwatches.   FragTimer can be run on any operating system 
with Python and Qt framework support.

Please send an email or post your questions, suggestions or bug reports to 
http://fragtimer.kodda.com/.   Your feedback is important and always 
welcome!

Official website: http://fragtimer.kodda.com/
Copyright (C) 2008 Eka Renardi (eka.renardi@gmail.com)


-------------------------
Minimum Requirements
-------------------------

To use FragTimer, you must have the following distributions:

- Python 2.5 or later is required (http://www.python.org/download/)
- Qt Framework 4.3 or later is required (http://trolltech.com)
- PyQt library v4 or later is required (http://www.riverbankcomputing.co.uk)


-------------------------
Installation
-------------------------

For end-users:

    Windows platform:
    
        A windows binaries package installer should have been created.  
        Start by selecting and executing the windows package installer.  
        This will put the program under "Program Files/FragTimer".    


    Other platform:
    
        Please follow the developer build instructions.


For developers:

    Build instructions:
        
        1. Change directory to src folder:   
        
            >> cd src
            
        2. Run the script make.py: 

            >> python make.py
        
            This will compile all scripts into python bytecode.   
            The main script is fragtimer.py
        
        
        ---- Applies only to Windows Developers ---
        
        To compile it for windows binaries, I have added the makewin.bat. 
        This requires the py2exe (http://www.py2exe.org/) libraries.  
        First follow the build instructions as above, and then execute 
        the makewin.bat.   Executing this will create the windows binaries 
        distribution under dist folder.
        
             >> makewin
        


-------------------------
License
-------------------------

FragTimer is released under the terms of the GNU General Public License.
Please refer to the 'LICENCE.GPL' file bundled with FragTimer

FragTimer uses the following great third party works :

- py2exe (http://www.py2exe.org/) released under MIT license.
  Used for building windows distribution

- nsis (http://nsis.sourceforge.net/Main_Page) release under zlib/libpng Lic.
  Used for building windows installation package

- Icons by Mark James released under the Creative Commons Attribution License.
 Mark James can be found at http://famfamfam.com .

- Icons from Tango Desktop Project released under Creative Commons Attribution 
 License. (http://tango.freedesktop.org/Tango_Desktop_Project)


-------------------------
Command Line Interface
-------------------------

If you are running the python script version (i.e. fragtimer.py), then 
FragTimer comes with a few command line switches.

The following options are available:
 
  Usage: FragTimer [options] args
  -t, --template=FILE: start app with the given template file
  -v, --version:       print the application version
  -h, --help:          print this usage

Example:
  To load a teatimer.ini file, you would type 
       
       >> FragTimer -t "teatimer.ini" 
       
       OR 
       
       >> FragTimer -template "teatimer.ini"
   

-------------------------
Template File (*.ini)
-------------------------

The template file contains various timer properties.

A typical timer properties is shown below:
    
  [Timer 1]                    	- Countdown timer/stopwatch name
  name = [Timer 1]		- Countdown timer/stopwatch name
  isprogressbar = [False|True] - Display countdown timer as progress bar  
                                    This option is only applicable for 
                                    countdown timer
  isstopwatch = [True|False] 	- Display this timer as a stopwatch(True)
                                    or countdown (False)
  color = #000000              	- Font color
  interval = [0,1,2,3]         	- Interval factor:
                                    0=milliseconds
                                    1=seconds
                                    2=minutes
                                    4=hours
  value = 1                    	- Interval value
  filename = timerlog.csv      	- Log file for each countdown start/stop event
                                    To disable logging, set this blank
  font = Helvetica,12,50,0     	- Font family, size, pointsize, bold
  isactive = [True,False]      	- Indicates if active
  sound = [True,False]		- Indicates if sound is to be played
  soundfile = filename.wav	- The sound file name to play
  soundinterval = 00000		- The sound interval value in milliseconds
						



-------------------------
Known Problems
-------------------------

1. The Stay On Stop functionality may not work correctly in *nix platform.