Skip to content
This repository has been archived by the owner on Oct 17, 2018. It is now read-only.

Commit

Permalink
Convert the README to rST, since that's what distutils wants.
Browse files Browse the repository at this point in the history
  • Loading branch information
ebroder committed Feb 25, 2010
1 parent 3ee06ad commit 94a556a
Showing 1 changed file with 19 additions and 18 deletions.
37 changes: 19 additions & 18 deletions README.md → README.rst
Expand Up @@ -7,23 +7,24 @@ Example Scenario
----------------

1. Larry lives with Curly and Moe.
2. Larry gets the utility bill, and enters it as an expenditure on their
BlueChips site. Everyone shares the utilities, so it's just an even split.
3. A week later, Moe pays the rent. Curly has a smaller room, so he pays a
smaller fraction of the rent.
4. At any time, any user can visit the BlueChips site and see who needs to pay
who how much in order to settle the books.
5. After a few months, Moe has paid for a disproportionate amount of stuff, so
the other roommates each make a transfer to Moe, and enter the amounts in
BlueChips.
2. Larry gets the utility bill, and enters it as an expenditure on
their BlueChips site. Everyone shares the utilities, so it's just an
even split.
3. A week later, Moe pays the rent. Curly has a smaller room, so he
pays a smaller fraction of the rent.
4. At any time, any user can visit the BlueChips site and see who
needs to pay who how much in order to settle the books.
5. After a few months, Moe has paid for a disproportionate amount of
stuff, so the other roommates each make a transfer to Moe, and
enter the amounts in BlueChips.

Additional Features
-------------------

* Support for negative expenses
* Uses any authentication mechanism which can set the REMOTE_USER environment
variable, including authentication modules supported by Apache, nginx,
lighttpd, and others.
* Uses any authentication mechanism which can set the REMOTE_USER
environment variable, including authentication modules supported by
Apache, nginx, lighttpd, and others.
* Email notifications of changes (optional)
* 100% test coverage

Expand All @@ -49,7 +50,7 @@ Apache Configuration

The recommended deployment platform for BlueChips is Apache, mod_wsgi, and any
Apache module which provides authentication. Here is an example vhost
configuration:
configuration::

<VirtualHost bluechips.example.com:80>
ServerName bluechips.example.com
Expand All @@ -68,7 +69,7 @@ configuration:
</Location>
</VirtualHost>

The ``bluechips.wsgi`` wrapper script looks just like:
The ``bluechips.wsgi`` wrapper script looks just like::

from paste.deploy import loadapp
application = loadapp('config:/var/www/ssl/config.ini')
Expand All @@ -80,12 +81,12 @@ BlueChips is the latest in a long line of software to make managing
group finances easier, and would not be possible without the
intellectual inspiration of those predecessors.

CUTCAT's [accounting software][cutcat] started the trend of
CUTCAT's `accounting software`_ started the trend of
software-based accounting mechanisms. It inspired a re-implementation
as a curses script by [Nelson Elhage][nelhage], which introduced the
as a curses script by `Nelson Elhage`_, which introduced the
notion of "pushing expenditures" to simplify transfers. The algorithm
used in BlueChips for settling the books is directly cargo-culted from
Nelson's implementation.

[cutcat]: http://cutc.at/accounting-software.html
[nelhage]: http://nelhage.com/
.. _accounting software: http://cutc.at/accounting-software.html
.. _Nelson Elhage: http://nelhage.com/

0 comments on commit 94a556a

Please sign in to comment.