updated the readme with a to do list for Fizz-C

1 files changed, 29 insertions, 1 deletions

diff --git a/readme b/readme
index 30d74d2..e323715 100644
--- a/readme
+++ b/readme
@@ -1 +1,29 @@
-test
\ No newline at end of file
+
+====
+Python Interface to the FEAST Feature Selection Toolbox
+====
+
+====
+About
+====
+This set of scripts provides an interface to the FEAST feature selection
+toolbox, originally written in C with a Mex interface to Matlab. Python 
+2.7 is required, along with Numpy. The feast.py module provides an inter-
+face to all the functionality of the FEAST implementation that was provided
+with the original Matlab interface. 
+
+====
+Demonstration
+====
+See demo_feast_wrapper.py for an example with uniform data and an image
+data set. The image data set was collected from the digits example in 
+the Scikits-Learn toolbox.
+
+====
+To Do
+====
+1) Add a setup.py script that can manage the build and installation of the
+   Python interface to FEAST. 
+2) Add in the rest of the functionality to feast.py. Add subsequent 
+   functionality into the demo. 
+3) Integrate the module into KBase!
\ No newline at end of file