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

[dunshire.git] / doc / README.rst

diff --git a/doc/README.rst b/doc/README.rst
new file mode 100644 (file)
index 0000000..6fe9ba6
--- /dev/null
+++ b/doc/README.rst
@@ -0,0 +1,21 @@
+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
+------------
+
+The only requirement is the CVXOPT library, available for most Linux
+distributions. Dunshire is targeted at python-3.x, but python-2.x will
+probably work too.
+
+[1] M. S. Gowda and G. Ravindran. On the game-theoretic value of a
+    linear transformation relative to a self-dual cone. Linear Algebra
+    and its Applications, 469:440-463, 2015.
+
+[2] You wish.
+
+[3] http://cvxopt.org/