Commit f56c9bdb authored by Paul McCarthy's avatar Paul McCarthy 🚵
Browse files

DOC: Update readme

parent e4131bd5
......@@ -11,6 +11,8 @@ fsleyes-widgets
.. image::
.. image::
The ``fsleyes-widgets`` package contains a collection of GUI widgets and
......@@ -19,9 +21,38 @@ used by `fsleyes-props <>`_ and
`FSLeyes <>`_,
You can install ``fsleyes-widgets`` via pip. If you are using Linux, you need
to install wxPython first, as binaries are not available on PyPI. Change the
URL for your specific platform::
pip install -f wxpython
Then install ``fsleyes-widgets`` like so::
pip install fsleyes-widgets
``fsleyes-widgets`` is also available on
`conda-forge <>`_::
conda install -c conda-forge fsleyes-widgets
All of the dependencies of ``fsleyes-widgets`` are listed in the
`requirements.txt <requirements.txt>`_ file.
Requirements for running tests and building the documentation are listed in the
`requirements-dev.txt <requirements-dev.txt>`_ file.
......@@ -30,12 +61,26 @@ Documentation
`sphinx <http://>`_. You can build the API documentation
by running::
pip install -r requirements-dev.txt
python doc
The HTML documentation will be generated and saved in the ``doc/html/``
Run the test suite via::
pip install -r requirements-dev.txt
python test
Many of the tests assume that a display is accessible - if you are running on
a headless machine, you may need to run the tests using ``xvfb-run``.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment