getting ready to close #36. Also affects #46

CHANGES.txt

@@ -0,0 +1,9 @@
+Release 0.0.2
+=============
+
+* Completed migration from QAP
+
+Release 0.0.1
+=============
+
+* Basic mriqc functionality

MANIFEST.in

@@ -0,0 +1,9 @@
+#documentation
+recursive-include docs/build/html *
+
+#data
+recursive-include mriqc/data *
+
+#Misc
+include CHANGES.txt
+include LICENSE.txt

README.rst

@@ -0,0 +1,28 @@
+mriqc
+=====
+
+The mriqc package provides a series of :abbr:`NR (no-reference)`,
+:abbr:`IQMs (image quality metrics)` to used in :abbr:`QAPs (quality
+assessment protocols)` for :abbr:`MRI (magnetic resonance imaging)`.
+
+Dependencies
+------------
+
+Make sure you have FSL and AFNI installed, and the binaries available in
+the system's $PATH.
+
+Installation
+------------
+
+Just issue:
+
+::
+
+    pip install mriqc
+
+Example command line:
+---------------------
+
+::
+
+    mriqc -i ~/Data/bids_dataset -o out/ -w work/

docs/source/index.rst

@@ -6,6 +6,9 @@
 Welcome to mriqc's documentation!
 =================================
 
+.. include:: ../../README.rst
+
+
 Contents:
 
 .. toctree::
@@ -19,5 +22,4 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-* :ref:`modules`
 

mriqc/qc/__init__.py

@@ -3,12 +3,12 @@
 # emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
 # vi: set ft=python sts=4 ts=4 sw=4 et:
 """
-This module contains the actual computation of measures included within
-MRIQC.
+This module contains the actual computation of :abbr:`IQMs (image quality
+metrics)` included within MRIQC.
 
 .. note ::
 
-  Most of the measures computed in this module are adapted, derived or reproduced
+  Most of the :abbr:`IQMs (image quality metrics)` in this module are adapted, derived or reproduced
   from the :abbr:`QAP (quality assessment protocols)` project [QAP]_.
 
 """