summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChris Dyer <cdyer@cab.ark.cs.cmu.edu>2012-10-02 01:10:44 -0400
committerChris Dyer <cdyer@cab.ark.cs.cmu.edu>2012-10-02 01:10:44 -0400
commitc742a52fcdb475f3131830f7df91de12cd7dd90a (patch)
tree92d2a53eabe985189667e14ed3e6394256b96458 /README.md
parentc9c7536ebd387479c2d39c8f1fa91bc047e0cac5 (diff)
new readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..d19fda3e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+`cdec` is a research platform for machine translation and similar structured prediction problems.
+
+## Installation
+
+Build `cdec`:
+
+ autoreconf -ifv
+ ./configure
+ make
+ ./tests/run-system-tests.pl
+
+You will need the following libraries / tools:
+
+ boost
+ GNU Autotools
+ GNU Flex
+
+## Further information
+
+[For more information, refer to the cdec documentation](http://www.cdec-decoder.org)
+