diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..42d9953c --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +`cdec` is a research platform for machine translation and similar structured prediction problems. + +## Building from a downloaded archive + +Instructions: + + ./configure + make + ./tests/run-system-tests.pl + +You will need the following software: + +- [Boost C++ libraries (version 1.44 or later)](http://www.boost.org/) + - If you build your own boost, you _must install it_ using `bjam install`. + - Older versions of Boost _may_ work, but problems have been reported with command line option parsing on some platforms with older versions. +- [GNU Flex](http://flex.sourceforge.net/) + +## Building from a git clone + +In addition to the standard `cdec` third party requirements, you will additionally need the following software: + +- [Autoconf / Automake / Libtool](http://www.gnu.org/software/autoconf/) + - Older versions of GNU autotools may not work properly. + +Instructions: + + autoreconf -ifv + ./configure + make + ./tests/run-system-tests.pl + +## Further information + +[For more information, refer to the `cdec` documentation](http://www.cdec-decoder.org) + |