<commit_before>TIME LOG
========

1. Purpose
----------
This program helps you keep a log of how much time you spend on specific
projects.

2. Approach
-----------
The program displays a small window of buttons at regular intervals. Each button
corresponds to a specific project that [your supervisors want] you want to
track. Once the button is pressed, the window is minimised (or disappears,
depending on the configuration).

The window re-appears at the specified interval. If a button is pressed within
the specified interval, the time elapsed since the window appeared will be
counted towards the previous entry.

If the task should be stopped or changed before the end of the interval, you can
maximise the program and then click on the STOP button or a different task,
respectively.

The program generates a simple CSV log, where each entry roughly corresponds to
each button click.

2. Compilation
--------------
Software required: JDK 6, Ant.

The program can be compiled with

  ant compile

Since the program is written in Java, it should compile and run on many
platforms.

3. Setting up the program
-------------------------
The configuration for the program is located in the "config.txt" file. In there,
you can specify various options including the time interval in seconds (default:
intervalInSeconds=3600), the file containing the project and sub-project names
(default: projectsFilename=projects.txt), and the output file for the log
entries (default: logFilename=log.txt).

3.1 Specifying the projects
---------------------------
Each line should begin with the name of a main project (a project that project
administration might care about). Each main project name can be followed by a
colon and a comma-separated list of sub-project names (mini projects that
mainly you care about logging individually). For example, to define a project
"A" with sub-projects "x", "y", and "z", the project file should contain the
line:

  A: x, y, z

Each name can have its tooltip appended in curly brackets, e.g.:

  A{A's tooltip}: x, y{y's tooltip}, z

3.2 Alternative behaviour
-------------------------
Some window managers do not support minimisation of windows (default:
behaviour=minimise). In that case, specifying "behaviour=hide" in the
"config.txt" file will instead completely hide the window. However, this does
make it more difficult to show the window again before the end of the specified
interval (e.g. to stop/change the logging).

4. Running the program
----------------------
Software required: JRE 6 (included with JDK 6), Ant.

The program can be run with

  ant run

or just

  ant

since "run" the the default target. Both of these options also compile the
program if required.<commit_msg>Added a note in the README file about feedback.<commit_after>TIME LOG
========

1. Purpose
----------
This program helps you keep a log of how much time you spend on specific
projects.

2. Approach
-----------
The program displays a small window of buttons at regular intervals. Each button
corresponds to a specific project that [your supervisors want] you want to
track. Once the button is pressed, the window is minimised (or disappears,
depending on the configuration).

The window re-appears at the specified interval. If a button is pressed within
the specified interval, the time elapsed since the window appeared will be
counted towards the previous entry.

If the task should be stopped or changed before the end of the interval, you can
maximise the program and then click on the STOP button or a different task,
respectively.

The program generates a simple CSV log, where each entry roughly corresponds to
each button click.

2. Compilation
--------------
Software required: JDK 6, Ant.

The program can be compiled with

  ant compile

Since the program is written in Java, it should compile and run on many
platforms.

3. Setting up the program
-------------------------
The configuration for the program is located in the "config.txt" file. In there,
you can specify various options including the time interval in seconds (default:
intervalInSeconds=3600), the file containing the project and sub-project names
(default: projectsFilename=projects.txt), and the output file for the log
entries (default: logFilename=log.txt).

3.1 Specifying the projects
---------------------------
Each line should begin with the name of a main project (a project that project
administration might care about). Each main project name can be followed by a
colon and a comma-separated list of sub-project names (mini projects that
mainly you care about logging individually). For example, to define a project
"A" with sub-projects "x", "y", and "z", the project file should contain the
line:

  A: x, y, z

Each name can have its tooltip appended in curly brackets, e.g.:

  A{A's tooltip}: x, y{y's tooltip}, z

3.2 Alternative behaviour
-------------------------
Some window managers do not support minimisation of windows (default:
behaviour=minimise). In that case, specifying "behaviour=hide" in the
"config.txt" file will instead completely hide the window. However, this does
make it more difficult to show the window again before the end of the specified
interval (e.g. to stop/change the logging).

4. Running the program
----------------------
Software required: JRE 6 (included with JDK 6), Ant.

The program can be run with

  ant run

or just

  ant

since "run" the the default target. Both of these options also compile the
program if required.

5. Feedback
-----------
All feedback is much appreciated. Please send it to:

  <NAME> <<EMAIL>>

Thanks.
{'fraction_non_alphanumeric': 0.09919427036705461, 'fraction_numerical': 0.0059086839749328554, 'mean_word_length': 3.3708920187793425, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2908858', 'n_tokens_mistral': 1432, 'n_tokens_neox': 1355, 'n_words': 829}