README file of Easycounter project v1.0.7 (http://easycounter.sourceforge.net)
Menu
I) Description
II) Installation
1) For running the executable on Windows 32 bits (x86 processors)
2) For executing the source code on all OS (Win32,Mac,Linux)
III) User Guide
1) "How to"
- Run the program - Add a counter - Remove a counter - Increment a counter ...
2) Hints
IV) Contact and Support
=====================================================================================================
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 configure at its creation for identifying and increasing/decreasing it.
Since v1.0.5, counters are grouped together in workspace for more convenience.
And v1.0.7 contains many corrections, improvements and allows to make a beep tone by any counter reaching a multiple of a number of 4 digits.
II) Installation
1) For executing the executable on Windows 32 bits (x86 processors)
Download the last zipped package (http://sourceforge.net/projects/easycounter/files/latest) in your temporary directory.
Extract all its internal files in a new final hosting directory (named "Easycounter" for example in the program directory, or in a personal one).
You can now go to the "User Guide" chapter III).
2) For executing the source code on all OS (Win32,Mac,Linux)
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.
- 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 final hosting directory (named "Easycounter" for example in the program directory, or in a personal one).
- 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 III.
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 this distribution:
Strawberry, the open source distribution of Perl for Microsoft Windows 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 package on perl.org site (http://www.perl.org/get.html) or use your system package manager (like rpm -i Perl, dbm).
For more details about Perl, visit http://www.perl.org/about.html .
- Step III : the Perl/Tk module
This module is necessary for windowing the script.
a) on all platforms
All the installing scripts are in the sub-directory "install".
You can even run hasPerl_[win or lin] as above or directly the appropriate script "hasPerlTk" with "_win.cmd" extension for Windows, or "_lin.sh" for Linux.
-> If it prompts the following message "Perl Tk is NOT INSTALLED!", continue on b) or c).
b) on Windows
Run install_PerlTk_win.cmd
Once the Perl/Tk module installed, you'll have the following message "Installation of Perl/Tk SUCCESSFUL!" and a prompt inviting you to press any key to see a graphical interface...
c) on Linux
Run install_PerlTk_lin.sh
Once the Perl/Tk module installed, you'll have the following message "Installation of Perl/Tk SUCCESSFUL!" and a prompt inviting you to press any key to see a graphical interface...
Congratulation! The Perl engine and Tk module are installed. Then, you can use the counter!
III) User Guide
1) "How to"
Run easycounter on Windows (32 bits min)
Find the binary easycounter_w32.exe in the directory "bin" with a file system explorer, and double clic on it. It shall open a command prompt displaying license terms of using, and thereafter the counter itself.
Run source code of easycounter on all platforms
Find the script easycounter.pl in the directory "src" with a file system explorer, and double clic on it. It shall open a command prompt 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" or press "Enter" 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.
Open a new workspace
Clic on the "+" tab or Ctrl+T. All workspaces are independent: saving, increasing, etc... counters of one of them doesn't interfere with the others.
Increment any counters
Each time you press a configured key, its associated counter increments.
Decrement any counters
Each time you press the "Alt" key continuously and a configured 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 or Ctrl+S saves the counters of the active workspace 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.
Make a beep periodically
You can specify in the entry zone at the column "Beep Period" of a counter or of the total, the number of increments after which a beep is emited.
This number is not saved in the csv file.
Recuperate after crash
Counters are recorded in a temporary file (in %TEMP% for Windows, or $TMP for Linux, directories) every 20 seconds. In case of a crash of the program without saving, reopening a workspace used before the crash will propose you to open the temporary file that can be considered like the "lost" old current version.
In ordinary case, the temporary file is destroyed after quitting the program normally.
2) Hints
The "Tabulation" (|<-
->|) 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", "Beep period").
The "Ctrl+T" keys combination adds a new workspace for working on others counters. The other workspaces are kept pending.
The "Ctrl+Tabulation" keys combination activates the workspace following the current one. The other workspaces are kept pending.
The "Ctrl+Shift+Tabulation" keys combination activates the workspace preceding the current one. The other workspaces are kept pending.
The "Ctrl+S" keys combination saves the counters of the active workspace in a file with ".csv" extension.
The "Ctrl+W" keys combination asks for saving counters if necessary before closing the active workspace.
The "Ctrl+Q" keys combination asks for saving the counters of all workspaces if necessary before quitting.
IV) Contact and Support
For different kind of request, here are useful links to sourceforge services:
-> submitting 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 : easycounter at outlook.fr
In any case, I'll try to satisfy you the best possible.
V) License
Easycounter is distributed under the GNU General Public License (see COPYING.txt file or http://www.gnu.org/licenses/).
Copyright David BALOGH (easycounter at outlook.fr).