]> gitweb.michael.orlitzky.com - dunshire.git/commitdiff
Mention additional build and development requirements.
authorMichael Orlitzky <michael@orlitzky.com>
Tue, 15 Nov 2016 15:56:34 +0000 (10:56 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Tue, 15 Nov 2016 15:56:34 +0000 (10:56 -0500)
doc/source/requirements.rst

index 8f82266ca58e2216e660cafc7d6e0242486f0d0a..e690e7f825a0ba3903a32d432c9fc44ca6dedead 100644 (file)
@@ -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
+<https://pypi.python.org/pypi/setuptools>`_. The only other requirement
+is the `CVXOPT <http://cvxopt.org/>`_ 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 <https://www.gnu.org/software/make/>`_ for convenience
+  and to build the documentation.
+* `Pylint <https://www.pylint.org/>`_ for code warnings.
+* `Sphinx <http://www.sphinx-doc.org>`_ to build the documentation.