X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=doc%2Fsource%2Frequirements.rst;h=19f787112735c8a7a0813808f2880790bd62bcc1;hb=38ed6ff99d1bb2e96d78927f5d1857a327fbccfa;hp=8f82266ca58e2216e660cafc7d6e0242486f0d0a;hpb=843d46c5be5605d071f17481c48ed0cb7f5acbaf;p=dunshire.git diff --git a/doc/source/requirements.rst b/doc/source/requirements.rst index 8f82266..19f7871 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.