Ignore activities.config and redmine.config; adding templates files

brunetton · Oct 9, 2014 · 77a7764 · 77a7764
1 parent f4a1c11
commit 77a7764
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 *~
 *.pyc
 git_ignored/
+activities.config
+redminetimesync.config
diff --git 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 → activities.config.tpl b/activities.config → activities.config.tpl
diff --git a/redminetimesync.config → redminetimesync.config.tpl b/redminetimesync.config → 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