diff --git a/README b/README index 19c65f2..60d45d8 100755 --- a/README +++ b/README @@ -1,9 +1,11 @@ -README money -============ +# README -money 0.2 +**money 0.2** -ABOUT +[Launchpad](launchpad.net/cli-money) +[Synoikos Gitbucket](git.synoikos.de/daniel/money) + +## ABOUT money is a Unix utility that keeps track of monthly income and expenditure. It is a money management software with a focus on ultimate @@ -13,14 +15,15 @@ Basically, this was written by a student for a student's needs :-) -INSTALLATION +## INSTALLATION Run the file install.sh as root. This will copy the script to -/usr/bin and create an initial budget file in ~/.money. +/usr/bin and create an initial budget file in `~/.money`. -USAGE +## USAGE +``` money [options] [parameters] Options: @@ -36,15 +39,15 @@ find Display all budget entries containing this string spent [comment] Log a spending received [comment] Log an amount received +``` - -DETAILS +## DETAILS money is a short Python script that uses a plain text file stored under -~/.money to save all budget information. This file has a very simple +`~/.money` to save all budget information. This file has a very simple syntax, as illustrated below. -[EXAMPLE] +``` Monthly budget + 900.00 Scholarship + 650.00 Side job @@ -62,8 +65,8 @@ - 53.00 Transport =============== Balance: 42.00 -[/EXAMPLE] - +``` + Each section contains the incomes and expenditures of one month. Sections are separated by an empty line. The first section contains the overall monthly budget (entries that are constant every month). This section has to be called @@ -89,17 +92,17 @@ budget file formatted as in the example. -CONTRIBUTING +## CONTRIBUTING -Contributions via Launchpad are welcome. Please note, however, that ultimate -simplicity remains money's primary goal - requests for features will be +Contributions via Launchpad or Gitbucket are welcome. Please note, however, that +ultimate simplicity remains money's primary goal - requests for features will be considered in the light of this. Apart from that, all contributions are very welcome, be they comments, patches or other. -LICENSE +## LICENSE - money 0.2 + money 0.2 Copyright (c) 2015 Daniel Vedder This program is free software: you can redistribute it and/or modify