From f6d1ebb62375614e4f84d1888b6a0ed33daee3f7 Mon Sep 17 00:00:00 2001 From: "Christopher J. Markiewicz" Date: Thu, 18 Jan 2018 13:10:59 -0600 Subject: [PATCH] DOC: Initial README --- README.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..809692da --- /dev/null +++ b/README.rst @@ -0,0 +1,19 @@ +FitLins - Fitting Linear Models to fMRI data +============================================ + +FitLins is a tool for estimating linear models, defined by the `BIDS Model`_ +specification proposal, to BIDS-formatted datasets. + +This software is in alpha stage, and should be considered unstable. +Users are welcome to test the software, and open issues. + +The CLI follows the `BIDS-Apps`_ convention: + +Usage:: + + fitlins/cli/run.py [--model ] + +See the output of ``fitlins/cli/run.py --help`` for all valid options. + +.. _"BIDS Model": https://docs.google.com/document/d/1bq5eNDHTb6Nkx3WUiOBgKvLNnaa5OMcGtD0AZ9yms2M/ +.. _BIDS-Apps: http://bids-apps.neuroimaging.io