aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README19
1 files changed, 19 insertions, 0 deletions
diff --git a/README b/README
index 861a27e..df114c1 100644
--- a/README
+++ b/README
@@ -1,4 +1,23 @@
+mga-treasurer
+-------------
+
mga-treasurer is a script that is used to generate a website showing
informations about latest donations received and expenses for Mageia.Org
association.
+
+Configuration file
+------------------
+
+The default configuration is stored in the file config_default installed
+as /usr/share/mga-treasurer/config. Default configuration values can be
+overrided using file /etc/mga-treasurer.conf.
+
+
+Testing
+-------
+
+For testing, you can set the environement variable MGATRES_CONF to the
+path of a default configuration file that will be used instead of
+/usr/share/mga-treasurer/config.
+