From: Michael Orlitzky <michael@orlitzky.com>
Date: Tue, 15 Nov 2016 03:26:16 +0000 (-0500)
Subject: Add a very basic README.rst to be used as my package description on pypi.
X-Git-Tag: 0.1.0~18
X-Git-Url: http://gitweb.michael.orlitzky.com/?p=dunshire.git;a=commitdiff_plain;h=9102140f1c80e92b8c520b16c47962476c73be6d

Add a very basic README.rst to be used as my package description on pypi.
---

diff --git a/doc/README.rst b/doc/README.rst
new file mode 100644
index 0000000..84f8321
--- /dev/null
+++ b/doc/README.rst
@@ -0,0 +1,16 @@
+Dunshire is a `CVXOPT <http://cvxopt.org/>`_-based library for solving
+linear (cone) games. The notion of a symmetric linear (cone) game was
+introduced by Gowda and Ravindran in *On the game-theoretic value of a
+linear transformation relative to a self-dual cone*. I've extended
+their results to asymmetric cones and two interior points in my
+thesis, which does not exist yet.
+
+The main idea can be gleaned from Gowda and Ravindran, however.
+Additional details and our problem formulation can be found in the
+full Dunshire documentation. The state-of-the-art is that only
+symmetric games can be solved efficiently, and thus the linear games
+supported by Dunshire are a compromise between the two: the cones are
+symmetric, but the players get to choose two interior points.
+
+Only the nonnegative orthant and the ice-cream cone are supported at
+the moment. The symmetric positive-semidefinite cone is coming soon.