Added README.txt

joaopalotti · Jul 13, 2016 · ab5ae74 · ab5ae74
1 parent 5ef6110
commit ab5ae74
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.txt b/README.txt
@@ -0,0 +1,17 @@
+======================
+TREC TOOLS
+======================
+
+A simple toolkit to process TREC files.
+
+Usage
+-----
+
+    #!/usr/bin/env python
+
+    from trectools import trec_run
+
+    tr = trec_run()
+
+    print tr.read_run("participant.run")
+