readme and text file update, add screenshots

Intera · Oct 21, 2019 · 9390355 · 9390355
1 parent d987d44
commit 9390355
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 48 deletions.
diff --git a/README.rdoc b/README.rdoc
diff --git a/VERSION b/VERSION
diff --git a/COPYRIGHT.txt → copyright.txt b/COPYRIGHT.txt → copyright.txt
@@ -1,4 +1,5 @@
 Redmine Timesheets is a Redmine plugin to create timesheets from all projects.
+Copyright (C) 2019  intera gmbh
 Copyright (C) 2007  Eric Davis, Little Stream Software
 
 This program is free software; you can redistribute it and/or

diff --git a/CREDITS.txt → credits.txt b/CREDITS.txt → credits.txt
@@ -1,11 +1,6 @@
 Thanks go to the following people for patches and contributions:
 
-Maintainers
-
 * Eric Davis
-
-Contributors
-
 * Morten Krogh Andersen
 * Peter Chester of Shane and Peter, Inc - Feature sponsorship
 * Anton Dollmaier

diff --git a/GPL.txt → gpl.txt b/GPL.txt → gpl.txt
diff --git a/other/screenshots/form.png b/other/screenshots/form.png
diff --git a/other/screenshots/result.png b/other/screenshots/result.png
diff --git a/readme.md b/readme.md
@@ -0,0 +1,39 @@
+# redmine timesheet plugin
+list and filter all timelog entries in redmine.
+
+compatible with redmine version 4 and 3.
+
+![form-screenshot](other/screenshots/form.png?raw=true)
+![result-screenshot](other/screenshots/result.png?raw=true)
+
+# features
+* filtering and sum of timelogs by date range, projects, activities and users
+* grouping of timelogs by project, issue and user
+* access control based on the user's projects and roles
+* permalinks to reports
+* special print style with total hours per day summaries
+* csv exports
+* version field in the report table
+* cleaned up form layout
+* headers of multiselects select all elements. they also deselect all elements if all elements are already selected
+* a new permission that allows to see all timelogs of all users (use case: secretary can print timesheets for the month for all users)
+* plugin hook support for changing the behavior of the plugin
+* user configurable precision for hours
+
+# installation
+1. in your redmine `plugins` directory, run the command: `git clone https://github.com/Intera/redmine_timesheet redmine_timesheet`
+2. restart the web server
+3. login and click the timesheet link in the top left menu
+
+## upgrade
+1. open a shell to your redmine `plugins/redmine_timesheet` directory
+2. update your git copy with `git pull`
+3. restart redmine
+
+# license
+gnu gpl v2.
+
+this plugin is a fork of the (original version)[https://github.com/edavis10/redmine-timesheet-plugin] by eric davis and has the same license.
+
+# see also
+(redmine time logging app)[https://github.com/Intera/redmine_time_logging_app] - let users log time for any project in one place