The Simplest Manual Counter Files

README file of Easycounter project v1.0.4 (http://easycounter.sourceforge.net)

I) Description

Easycounter is an open source manual counter offering the easiest counting with your keyboard.
Each counter refers to a name and a key (a letter or a number) you configurate at its creation for identifying and incrementing/decrementing it.

II) Installation

  The installation follows three steps:
    the download/installation of easycounter in step I.
    the download/installation of the Perl engine in step II.
    and the download/installation of the Perl/Tk module in step III.
  
  II- Step I : easycounter
  Download the last zipped package (http://sourceforge.net/projects/easycounter/files/latest) in your temporary directory.
  Extract all its internal files in a new hosting directory (named "Easycounter" for example).
  
	II- Step II : the Perl engine

	a) on all platforms
All the installing scripts are in the sub-directory "install".
Run the appropriate script "hasPerl" with "_win.cmd" extension for Windows, or "_lin.sh" for Linux.
-> If it prompts the following message "Perl engine is not installed", continue on b) or c).
-> If you have "Perl engine is already installed!", go straight to II- Step II.
In both case, a message invites you to press any key to continue... Press a key, and that ends the hasPerl script.

	b) on Windows
In case the result of the previous a) step tells "Perl engine is not installed", install the engine accepting all the usual configuration parameters of one of these two distributions: 
Activestate company distributes an engine free of charge at this url:
	http://www.activestate.com/activeperl/downloads/
Strawberry, the open source distribution of Perl for Microsoft Windows is available at:
	http://strawberryperl.com/

	c) on Linux
In case the result of the previous a) step tells "Perl engine is not installed", get the installation packages either on Activestate company site or use your system package manager (rpm -i Perl, dbm).

For more details about Perl, visit http://www.perl.org/about.html .

	II- Step III : the Perl/Tk module
This module is necessary for windowing the script.

	a) on Windows
Run install_PerlTk_win.cmd
Once the module Tk installed, you'll have the following message "Installation of Perl/Tk SUCCESFULL!" and a prompt inviting you to press any key to continue... Press a key, and that ends the script.

	b) on Linux
Run install_PerlTk_lin.sh
Once the module PerlTk installed, you'll have the following message "Installation of Perl/Tk SUCCESFULL!" and a prompt inviting you to press any key to continue... Press a key, and that ends the script.


The Perl engine and Tk module are installed, congratulation. Then, you can use the script!


III) User Guide

  Hints
The "tab" (|<-
           ->|) key allows jumping between fields/buttons without the mouse.
The "Esc" key activates the keys (letters) for counting when the cursor is placed in a textual entry zone ("name", "key", "file").

    Run easycounter on all platforms
Find the script starteasycounter.pl in the directory "src" with a file system explorer, and double clic on it. It shall open a black window displaying license terms of using, and thereafter the counter itself.

    Create counters and use them
Write the name of the counter in the "name" entry zone, and the associated key (usually a letter) in "key" zone. Click "add" for each counters: they shall appear in the left frame.

    Open existing counters
- Clic on "Browse", select the "csv" file wanted, and then clic on "open" button.
or
- Write the file name in "file" entry zone, and press "Enter" key.

    Increment any counters
Each time you press a configurated key, its associated counter increments.

    Decrement any counters
Each time you press the "Alt" key continuously and a configurated key, its associated counter decrements.

    Undo a count
The left arrow can step backward for correcting ten increments maximum.

    Redo counting (recuperating it)
The right arrow can step forward for cancelling ten undone increments maximum.
    
    Save in a file
Click on "Save" button will save the counters in a file with ".csv" extension. Then it can be opened later with a spreadsheet.

    Add counters
It is possible to add counters whenever you want: after having opened a file, after having started counting. It keeps the existing previous counters.

    Recuperate after crash
The counters are recorded in a temporary file (in %TEMP% or $TMP directories) every 20 seconds. In case of a crash of the program without saving, the running of it will propose you to open the temporary file.
In ordinary case, the temporary file is destroy after each stop of the program.

IV) Programmers' guide

Since release 1.0.2, the script is written in object oriented syntax.
You shall find in starteasycounter.pl a commented block starting with "This is an example of using Easycounter class within a container :". It's a dozen of lines showing how to integrate easily the counter in an existing Perl/Tk script.

V) Curiosities and generals knowledge for neophytes

Technically, this 'program' is a script, and runs under the Perl engine. A script is a file containing basic commands to control a computer (generally its settings, file systems and running processes).
Assuming that an engine is a program understandable by a computer, a script can not be executed by a computer on its own: it needs the engine to interpret it, and makes the run possible.
The advantage of it, is the freedom of having only one script for each different operating systems. On the other hand, we need a proper engine for every operating systems.

VI) Contact and Support

  For different kind of request, here are usefull links to sourceforge services:
-> submiting an idea for improvement : https://sourceforge.net/tracker/?group_id=306325&atid=1290646
-> get support : https://sourceforge.net/tracker/?group_id=306325&atid=1290644
-> reporting bugs : https://sourceforge.net/tracker/?group_id=306325&atid=1290643
-> direct contact : david.balogh at free.fr

In any case, I'll try to satisfy you the best possible.

VII) License
Easycounter is distributed under the GNU General Public License (see COPYING.txt file or http://www.gnu.org/licenses/).

Copyright 2010 David BALOGH.