From: Michael Orlitzky Date: Tue, 15 Nov 2016 15:56:34 +0000 (-0500) Subject: Mention additional build and development requirements. X-Git-Tag: 0.1.0~11 X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=e7c55686a451f1f708eac2652f147acb1c0ec70c;p=dunshire.git Mention additional build and development requirements. --- diff --git a/doc/source/requirements.rst b/doc/source/requirements.rst index 8f82266..e690e7f 100644 --- a/doc/source/requirements.rst +++ b/doc/source/requirements.rst @@ -1,6 +1,22 @@ Requirements ------------ -The only requirement is the CVXOPT library, available for most Linux +Dunshire is a Python library, so it needs a Python interpreter. To +"build" it, you'll need `Setuptools +`_. The only other 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. + +So, end users require: + +* python (tested: 3.4, 3.5) +* setuptools (tested: 20.6.7) +* cvxopt (tested: 1.1.8) + +Developers will also want: + +* `GNU Make `_ for convenience + and to build the documentation. +* `Pylint `_ for code warnings. +* `Sphinx `_ to build the documentation.