Add simple README and settings file for specifying yourHEADmaster

jira credentials.

2 files changed, 30 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..6562eb5
--- /dev/null
+++ b/README
@@ -0,0 +1,24 @@
+PREREQ:
+
+pip install jira
+
+You need to have at least jira 1.0 installed. 
+
+
+USAGE:
+
+./initiative-report.py 
+usage: initiative-report.py [-h] [-d] -p PROJECT -i INITIATIVE
+
+Example: initiative-report.py  -p LMG -i LMG-390
+
+
+Credentials:
+Don't forget to rename settings.cfg.sample as settings.cfg and then
+update the fire accordingly so it is able to access projects.linaro.org
+as you.
+
+
+Yes this does nasty things like storing your password in a file and yes
+I shouldn't do that... did I mention I accept patches?
+
diff --git a/settings.cfg.sample b/settings.cfg.sample
new file mode 100644
index 0000000..b1de718
--- /dev/null
+++ b/settings.cfg.sample
@@ -0,0 +1,6 @@
+[Jira]
+Server: https://projects.linaro.org/
+Username: 
+Password: 
+[common]
+outputfile: cards.log