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

DOC: Update readme

parent e4131bd5
...@@ -11,6 +11,8 @@ fsleyes-widgets ...@@ -11,6 +11,8 @@ fsleyes-widgets
.. image:: https://img.shields.io/pypi/v/fsleyes-widgets.svg .. image:: https://img.shields.io/pypi/v/fsleyes-widgets.svg
:target: https://pypi.python.org/pypi/fsleyes-widgets/ :target: https://pypi.python.org/pypi/fsleyes-widgets/
.. image:: https://anaconda.org/conda-forge/fsleyes-widgets/badges/version.svg
:target: https://anaconda.org/conda-forge/fsleyes-widgets
The ``fsleyes-widgets`` package contains a collection of GUI widgets and The ``fsleyes-widgets`` package contains a collection of GUI widgets and
...@@ -19,9 +21,38 @@ used by `fsleyes-props <https://git.fmrib.ox.ac.uk/fsl/fsleyes/props>`_ and ...@@ -19,9 +21,38 @@ used by `fsleyes-props <https://git.fmrib.ox.ac.uk/fsl/fsleyes/props>`_ and
`FSLeyes <https://git.fmrib.ox.ac.uk/fsl/fsleyes/fsleyes>`_, `FSLeyes <https://git.fmrib.ox.ac.uk/fsl/fsleyes/fsleyes>`_,
Installation
------------
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 https://extras.wxpython.org/wxPython4/extras/linux/gtk2/ubuntu-16.04/ wxpython
Then install ``fsleyes-widgets`` like so::
pip install fsleyes-widgets
``fsleyes-widgets`` is also available on
`conda-forge <https://conda-forge.org/>`_::
conda install -c conda-forge fsleyes-widgets
Dependencies
------------
All of the dependencies of ``fsleyes-widgets`` are listed in the All of the dependencies of ``fsleyes-widgets`` are listed in the
`requirements.txt <requirements.txt>`_ file. `requirements.txt <requirements.txt>`_ file.
Requirements for running tests and building the documentation are listed in the
`requirements-dev.txt <requirements-dev.txt>`_ file.
Documentation Documentation
------------- -------------
...@@ -30,12 +61,26 @@ Documentation ...@@ -30,12 +61,26 @@ Documentation
`sphinx <http://http://sphinx-doc.org/>`_. You can build the API documentation `sphinx <http://http://sphinx-doc.org/>`_. You can build the API documentation
by running:: by running::
pip install -r requirements-dev.txt
python setup.py doc python setup.py doc
The HTML documentation will be generated and saved in the ``doc/html/`` The HTML documentation will be generated and saved in the ``doc/html/``
directory. directory.
Tests
-----
Run the test suite via::
pip install -r requirements-dev.txt
python setup.py 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``.
Contributing Contributing
------------ ------------
......
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