summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 14 insertions, 8 deletions
diff --git a/README.md b/README.md
index d89e9558..c282d468 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,30 @@
`cdec` is a research platform for machine translation and similar structured prediction problems.
-## Installation
+## Building from a downloaded archive
-Build `cdec`:
-
- autoreconf -ifv
./configure
make
./tests/run-system-tests.pl
-You will need the following libraries / tools:
+You will need the following software:
-- [Autoconf / Automake / Libtool](http://www.gnu.org/software/autoconf/)
- - Older versions of GNU autotools may not work properly.
- [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.
+ autoreconf -ifv
+ ./configure
+ make
+ ./tests/run-system-tests.pl
+
## Further information
-[For more information, refer to the cdec documentation](http://www.cdec-decoder.org)
+[For more information, refer to the `cdec` documentation](http://www.cdec-decoder.org)