]> gitweb.michael.orlitzky.com - dunshire.git/blobdiff - doc/source/requirements.rst
doc/source/requirements.rst: update various versions.
[dunshire.git] / doc / source / requirements.rst
index 8f82266ca58e2216e660cafc7d6e0242486f0d0a..eba8614239ca4070ae154c76b3cb8576c468bf2b 100644 (file)
@@ -1,6 +1,21 @@
 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.
+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 <https://cvxopt.org/>`_ library, available for most Linux
+distributions.
+
+So, end users require:
+
+* python (tested: 3.8, 3.9, 3.10)
+* setuptools (tested: 65.7.0)
+* cvxopt (tested: 1.3.0)
+
+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 <https://www.sphinx-doc.org/>`_ to build the documentation.