Move the README into doc/, add it to the Sphinx index, and tweak that.

[dunshire.git] / doc / README.rst

diff --git a/README b/doc/README.rst
similarity index 92%
rename from README
rename to doc/README.rst
index 06dead08c101b546285fb0f1c8e97f2907220d4c..6fe9ba6ca2f5c6db0e82979deab2c764f6a8d66d 100644 (file)
--- a/README
+++ b/doc/README.rst
@@ -1,10 +1,12 @@
-== Overview ==
+Overview
+--------
 
 Dunshire is a CVXOPT-based library for solving linear (cone)
 games. The notion of a cone game was introduced by Gowda[1] and
 extended to asymmetric cones in my thesis[2].
 
-== Requirements ==
+Requirements
+------------
 
 The only requirement is the CVXOPT library, available for most Linux
 distributions. Dunshire is targeted at python-3.x, but python-2.x will