better readme, example and code

1 files changed, 36 insertions, 3 deletions

diff --git a/README.md b/README.md
index f43f61d..182195e 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,41 @@
 rebol
 =====
 
-code for grounded SMT
+Code for grounded SMT on geoquery data.
+(This has nothing to do with the programming language REBOL! http://www.rebol.com/ )
 
-This has nothing to do with the programming language REBOL
-http://www.rebol.com/
+
+Dependencies
+------------
+
+*WASP*-1.0 includes the geoquery knowledge base and scripts for querying it.
+The evaluation scripts were slightly modified to include the full output.
+These scripts are in data/geoquery/wasp/, they go into wasp-1.0/data/geo-funql/eval/.
+WASP-1.0 can be downloaded from here [1].
+
+You'll also need some *Prolog* environment, e.g. SWI-Prolog [2].
+
+We use the a slightly modified implementation of *smt-semparse*,
+as described in 'Semantic parsing as machine translation' (Andreas et al, ACL 2013).
+Our fork can be found here [3]. This depends on more stuff, e.g. the Moses decoder
+and SRILM.
+
+For translation we use the *cdec* toolkit, [4].
+
+As semantic parsing is quite slow and rebol does it quite often,
+results are cached with *memcached* [5].
+
+You'll also need the following *ruby gems*:
+ * https://rubygems.org/gems/memcached
+ * http://rubygems.org/gems/nlp_ruby
+ * http://trollop.rubyforge.org/
+
+
+
+---
+[1] http://www.cs.utexas.edu/~ml/wasp/wasp-1.0.tar.bz2
+[2] http://www.swi-prolog.org/
+[3] https://github.com/pks/smt-semparse
+[4] https://github.com/redpony/cdec
+[5] http://memcached.org/