From 77a7764760d49065c1bb5a6dcdf2b4284468a029 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bruno=20Duy=C3=A9?= Date: Thu, 9 Oct 2014 20:00:55 +0200 Subject: [PATCH] Ignore activities.config and redmine.config; adding templates files --- .gitignore | 2 ++ README.md | 7 +++++-- activities.config => activities.config.tpl | 0 redminetimesync.config => redminetimesync.config.tpl | 2 +- 4 files changed, 8 insertions(+), 3 deletions(-) rename activities.config => activities.config.tpl (100%) rename redminetimesync.config => redminetimesync.config.tpl (93%) diff --git a/.gitignore b/.gitignore index a4bb802..817e13b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ *~ *.pyc git_ignored/ +activities.config +redminetimesync.config diff --git a/README.md b/README.md index 1701f0d..f373236 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ INSTALLATION ------------ 1. Clone the repository - -2. Edit **redminetimesync.config**: it's an INI-like file that needs two parameters: + +2. Copy `redminetimesync.config.tpl` to `redminetimesync.config` : it's an INI-like file that needs two parameters: - url: your Redmine public url - key: your Redmine API key @@ -43,6 +43,9 @@ ADVANCED CONFIGURATION ### Activities +Activities are defined in `activities.config` file. You can copy sample file `activities.config.tpl` (and rename it) +and adjust it for your needs. + #### Default activity When adding times in Redmine, default activity is associated with time entry, if a default activity is defined. If there is no default activity defined in Redmine, the script will raise an error (because you're trying to add a new time entry with no activity associated). There are two workarounds : diff --git a/activities.config b/activities.config.tpl similarity index 100% rename from activities.config rename to activities.config.tpl diff --git a/redminetimesync.config b/redminetimesync.config.tpl similarity index 93% rename from redminetimesync.config rename to redminetimesync.config.tpl index b5fc85a..82c2dab 100644 --- a/redminetimesync.config +++ b/redminetimesync.config.tpl @@ -11,4 +11,4 @@ issue_id_regexp: .*# ?(\d+) # Activity id sent to each time entry (uncomment this if you have an error in Redmine due to undefined default activity) # See activities.config file for an enhanced control upon activities -;redmine_default_activity_id: 9 +#redmine_default_activity_id: 9