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

README.md moved to README.rst, because pypi doesn't support md. Xvfb install

tweak
parent 066be4a6
...@@ -212,7 +212,7 @@ variables: ...@@ -212,7 +212,7 @@ variables:
# Linux builds for wxPython are currently # Linux builds for wxPython are currently
# not on pypi, but are available at this # not on pypi, but are available at this
# url. # url.
- apt-get install xvfb - apt-get install -y xvfb
- pip install -f https://wxpython.org/Phoenix/release-extras/linux/gtk3/debian-8/ wxpython - pip install -f https://wxpython.org/Phoenix/release-extras/linux/gtk3/debian-8/ wxpython
# All other deps can be installed as normal # All other deps can be installed as normal
......
include LICENSE include LICENSE
include COPYRIGHT include COPYRIGHT
include README.md
include requirements.txt include requirements.txt
include pytest.ini include pytest.ini
recursive-include doc * recursive-include doc *
......
fslpy
=====
The `fslpy` project is a [FSL](http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/)
programming library written in Python. It is used by
[FSLeyes](https://git.fmrib.ox.ac.uk/paulmc/fsleyes/).
Dependencies
------------
All of the dependencies of `fslpy` are listed in the
[requirements.txt](requirements.txt) file. Some `fslpy` modules require
[wxPython](http://www.wxpython.org) 3.0.2.0.
Documentation
-------------
`fslpy` is documented using [sphinx](http://http://sphinx-doc.org/). You can
build the API documentation by running:
python setup.py doc
The HTML documentation will be generated and saved in the `doc/html/` directory.
If you are interested in contributing to `fslpy`, check out the [contributing
guide](doc/contributing.rst).
Tests
-----
Run the test suite via:
python setup.py test
A test report will be generated at `report.html`, and a code coverage report
will be generated in `htmlcov/`.
fslpy
=====
The ``fslpy`` project is a `FSL <http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/>`_
programming library written in Python. It is used by `FSLeyes
<https://git.fmrib.ox.ac.uk/paulmc/fsleyes/>`_.
Dependencies
------------
All of the dependencies of ``fslpy`` are listed in the `requirements.txt
<requirements.txt>`_ file. Some ``fslpy`` modules require `wxPython
<http://www.wxpython.org>`_ 3.0.2.0 or higher.
Documentation
-------------
``fslpy`` is documented using `sphinx <http://http://sphinx-doc.org/>`_. You
can build the API documentation by running::
python setup.py doc
The HTML documentation will be generated and saved in the ``doc/html/``
directory.
If you are interested in contributing to ``fslpy``, check out the
`contributing guide <doc/contributing.rst>`_.
Tests
-----
Run the test suite via::
python setup.py test
A test report will be generated at ``report.html``, and a code coverage report
will be generated in ``htmlcov/``.
...@@ -37,7 +37,7 @@ with open(op.join(basedir, "fsl", "version.py")) as f: ...@@ -37,7 +37,7 @@ with open(op.join(basedir, "fsl", "version.py")) as f:
break break
version = version['__version__'] version = version['__version__']
with open(op.join(basedir, 'README.md'), 'rt') as f: with open(op.join(basedir, 'README.rst'), 'rt') as f:
readme = f.read() readme = f.read()
......
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