Permalink
Browse files

Add a README.md file

  • Loading branch information...
1 parent afa0b8a commit 726dc335130b03f9458a8237559d13f578e59fed @prashtx prashtx committed Apr 13, 2012
Showing with 16 additions and 0 deletions.
  1. +16 −0 README.md
View
@@ -0,0 +1,16 @@
+FORMBOT 2000
+============
+
+The name says it all! This is the form-processing robot of the future!
+
+Formbot 2000 processes scanned images of fill-in-the-bubble forms. It's meant to interact with the survey-api server. It will get scanned images using the API and send back the results.
+
+To process all of the scanned forms with status `pending`:
+
+ $ ./process_form.py
+
+To process one scanned form:
+
+ $ ./process_form.py ID_OF_SCAN
+
+`readform.py` can be used to process a local image, for testing.

0 comments on commit 726dc33

Please sign in to comment.