New README file

README

-fslpy - front end to the FSL tools.
-
-Dependencies:
-
- - PyOpenGL   3.1.0
- - numpy      1.8.1
- - scipy      0.14.0
- - matplotlib 1.3.1
- - nibabel    1.3.0
- - Pillow     2.5.3 (for screenshots of any type other than PNG)
- - PyParsing  2.0.3
- - Jinja2     2.8
- - wxPython   3.0.0.0
-
- - OSMesa 6.5.3 (for off-screen rendering)
-
- - OpenGL. Either
-   - OpenGL 1.4, with the following extensions:
-     - ARB_vertex_program
-     - ARB_fragment_program
-     - EXT_framebuffer_object
-   - OpenGL 2.1, with the following extensions:
-     - EXT_framebuffer_object
-     - ARB_instanced_arrays
-     - ARB_draw_instanced
-
-Some of the icons are derived from the Freeline icon set, by Enes Dal,
-available at https://www.iconfinder.com/Enesdal, and released under the
-Creative Commons (Attribution 3.0 Unported) license.

README.md

+fslpy
+=====
+
+The `fslpy` project is a collection of
+[FSL](http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/) tools written in Python. Most
+importantly, it is the home of *FSLeyes*, the FSL image viewer.
+
+
+
+Documentation
+-------------
+
+
+Installation: https://git.fmrib.ox.ac.uk/paulmc/fslpy/wikis/home
+
+For users: `<todo - link to hosted docs>`
+
+For developers: `<todo - link to hosted apidocs>`
+
+
+
+Dependencies
+------------
+
+
+`fslpy` depends upon the following libraries:
+
+
+================================================= =======
+Library                                           Version
+
+[props](https://git.fmrib.ox.ac.uk/paulmc/fslpy/) Latest  
+[PyOpenGL](http://pyopengl.sourceforge.net/)      3.1.0   
+[numpy](http://www.numpy.org/)                    1.8.1
+[scipy](http://www.scipy.org/)                    0.14.0
+[matplotlib](http://matplotlib.org/)              1.4.3
+[nibabel](http://nipy.org/nibabel/)               1.3.0
+[Pillow](https://python-pillow.github.io/)        2.5.3
+[PyParsing](http://pyparsing.wikispaces.com/)     2.0.3
+[Jinja2](http://jinja.pocoo.org/)                 2.8
+[wxPython](http://wxpython.org/)                  3.0.2.0
+[OSMesa](http://mesa3d.org/)                      8.0.5
+================================================= =======
+
+
+ > If you are installing `fslpy` manually, don't worry too much about having
+ > the exact version of each of the packages - just try with the latest
+ > version, and roll-back if you have problems.
+
+
+Being an OpenGL application, *FSLeyes* can only be used on computers
+with graphics hardware that supports one of the following versions:
+
+ - OpenGL 1.4, with the following extensions:
+   - `ARB_vertex_program`
+   - `ARB_fragment_program`
+   - `EXT_framebuffer_object`
+
+ - OpenGL 2.1, with the following extensions:
+   - `EXT_framebuffer_object`
+   - `ARB_instanced_arrays`
+   - `ARB_draw_instanced`
+
+
+Credits
+-------
+
+
+Some of the icons are derived from the Freeline icon set, by Enes Dal,
+available at https://www.iconfinder.com/Enesdal, and released under the
+Creative Commons (Attribution 3.0 Unported) license.