]> gitweb.michael.orlitzky.com - dunshire.git/blob - doc/source/requirements.rst
Mention additional build and development requirements.
[dunshire.git] / doc / source / requirements.rst
1 Requirements
2 ------------
3
4 Dunshire is a Python library, so it needs a Python interpreter. To
5 "build" it, you'll need `Setuptools
6 <https://pypi.python.org/pypi/setuptools>`_. The only other requirement
7 is the `CVXOPT <http://cvxopt.org/>`_ library, available for most Linux
8 distributions. Dunshire is targeted at python-3.x, but python-2.x will
9 probably work too.
10
11 So, end users require:
12
13 * python (tested: 3.4, 3.5)
14 * setuptools (tested: 20.6.7)
15 * cvxopt (tested: 1.1.8)
16
17 Developers will also want:
18
19 * `GNU Make <https://www.gnu.org/software/make/>`_ for convenience
20 and to build the documentation.
21 * `Pylint <https://www.pylint.org/>`_ for code warnings.
22 * `Sphinx <http://www.sphinx-doc.org>`_ to build the documentation.