Adds readme (user documentation) with some screenshots

TimeTracker/Properties/AssemblyInfo.cs

@@ -41,6 +41,6 @@
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
 
-[assembly: AssemblyVersion("1.3.*")]
+[assembly: AssemblyVersion("1.4.*")]
 [assembly: NeutralResourcesLanguage("")]
 

examples/table.timetracker

@@ -0,0 +1,7 @@
+2000-01-01T00:00:30.0000000+00:00,2000-01-01T08:00:30.0000000+00:00,Hello World
+2000-01-01T08:05:15.0000000+00:00,2000-01-01T12:00:00.0000000+00:00,Lone Category
+2000-01-01T12:04:28.0000000+00:00,2000-01-01T12:04:29.0000000+00:00,Also a Category
+2000-01-01T12:04:33.0000000+00:00,2000-01-01T12:20:34.0000000+00:00,Also a Category
+2000-01-01T12:34:40.0000000+00:00,2000-01-01T12:34:55.0000000+00:00
+2000-01-01T14:06:25.0000000+00:00,2000-01-01T14:06:28.0000000+00:00,Also a Category
+2000-01-01T16:44:09.0000000+00:00,2000-01-01T17:30:10.0000000+00:00

readme.md

@@ -0,0 +1,48 @@
+# Time Tracker
+
+A simple time tracking application made as a part of "Programming for Windows"
+course on University of Finance and Administration,
+department of Informatics and Mathematics.
+Written in C# / .NET 4 and using the WinForms library,
+released publicly as open-source software under MIT license.
+
+
+## Features
+
+* Time tracking
+* Visual display of currently tracked time
+* Set tracking categories (or pick a category that's already in the table)
+* Delete inconvenient entries
+* Open / Save time tracker table files (which use CSV-like format that is easy to process further)
+* Generic window manager options (stay on top, show in notification area, ...)
+* Language picker (currently available in Czech and English) with Windows' locale autodetection.
+* Settings are persisted in local storage
+
+
+## Usage
+
+1. Star tracking by clicking the ![Start Tracking](/screenshots/btn_start_tracking.png?raw=true) button
+2. The two read-only fields now show the time when tracking started and how much time elapsed since then: ![Two fields with absolute time and elapsed time](/screenshots/tracking_info.png?raw=true)
+3. Optionally fill in the "category" field: ![A text field with "Awesome Cat" filled in](/screenshots/category_field.png?raw=true)
+4. Stop the tracking by clicking the ![Stop Tracking](/screenshots/btn_stop_tracking.png?raw=true) button
+5. A new record will appear in the table below: ![Example Time Tracker record](/screenshots/example_record.png?raw=true)
+
+
+## Screenshots
+
+The following screenshot represents the table from [examples/table.timetracker](/examples/table.timetracker):
+
+![Example TimeTracker table displayed in the program's GUI](/screenshots/example_table.png?raw=true)
+
+
+## Installation
+
+You can either grab the [latest release](https://github.com/Amunak/TimeTracker/releases/latest), unpack it and run `timetracker.exe` or compile the software yourself.
+
+### Compiling
+
+Clone this repository, open the solution (`TimeTracker.sln`) in Visual Studio,
+pick a configuration (I'd suggest `release` unless you plan to tinker with the code)
+and select `Build > Compile Solution`. The built code should appear in the project directory
+under `bin/Release`. You'll see `timetracker.exe` here
+(along with some generated resource files and default config).