Added info to readme
authorMauro Scomparin <scompo@gmail.com>
Thu, 5 Jul 2018 22:02:19 +0000 (00:02 +0200)
committerMauro Scomparin <scompo@gmail.com>
Thu, 5 Jul 2018 22:02:19 +0000 (00:02 +0200)
README.rst

index 744401b24167244361a88cb962ee3c5f22f09710..6248b9ccc9821a10c21b9ed4d1da4aec97280719 100644 (file)
@@ -2,3 +2,31 @@ money
 =====
 
 python script I run on my phone to log my expenses.
+
+Installation
+************
+
+To install the latest version just
+
+::
+
+  $ git clone http://code.scompo.it:3000/scompo/money.git
+  $ cd money
+  $ python3 setup.py install
+
+Configuration
+*************
+
+Config file location: $HOME/.config/money.conf
+
+Default values
+**************
+
+The default configuration it's equivalent to:
+
+::
+
+ {
+    "dataFile":"movimenti.dat",
+    "latestMovementsNumber": 5
+ }