]> asedeno.scripts.mit.edu Git - bluechips.git/commitdiff
Convert the README to rST, since that's what distutils wants.
authorEvan Broder <broder@mit.edu>
Thu, 25 Feb 2010 05:18:45 +0000 (00:18 -0500)
committerEvan Broder <broder@mit.edu>
Thu, 25 Feb 2010 05:19:02 +0000 (00:19 -0500)
README.rst [moved from README.md with 77% similarity]

similarity index 77%
rename from README.md
rename to README.rst
index 8c17a0eac56e13e8e9d2c9eaf058412936a6ca60..1db26fd35001eef8a4b99cfc29f64f14c8fbfffd 100644 (file)
--- a/README.md
@@ -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
 
@@ -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
@@ -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')
@@ -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/