Update documentation, add example and install script.

[bold.git] / doc / README

diff --git a/doc/README b/doc/README
index a66fb64b3aad0c8ddc8b7c4c7ae33625dbeb2051..83188380c4335dc1443ae8c69ee6f40f6851b26b 100644 (file)
--- a/doc/README
+++ b/doc/README
@@ -1,4 +1,4 @@
-.. HTML version generated with rst2html -t README > README.html
+.. HTML version generated with LC_ALL=C rst2html -t README > README.html
 
 .. |date| date:: %b %e, %Y
 
@@ -60,7 +60,14 @@ recompile the source code into an object file.
 Installation
 ============
 
-TBD.
+Go into Bold's directory, and run ::
+
+  python setup.py build
+
+Then, as root or using sudo, run ::
+
+  python setup.py install
+
 
 
 Using Bold
@@ -213,4 +220,9 @@ Executables generated by ``ld`` usually have a lot of entries in their
 And that's it!
 
 
+Examples
+========
 
+The ``examples/`` directory contains a port of the *flow2* intro
+(http://www.pouet.net/prod.php?which=30589). Adding the dropper is left as an
+exercise for the reader.