summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Dyer <redpony@gmail.com>2014-05-25 23:46:46 -0400
committerChris Dyer <redpony@gmail.com>2014-05-25 23:46:46 -0400
commit75c05abc3adf51a8ee05fe0a92536ac89e3be7d1 (patch)
tree7a1e37fa69af5019b4c6e7825f0ec73a50624409
parent362ece653b71b3772cba24214855c47bb14e8117 (diff)
fix readme
-rw-r--r--README.md22
1 files changed, 12 insertions, 10 deletions
diff --git a/README.md b/README.md
index 8f335adb..3cbc62c3 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,13 @@
`cdec` is a research platform for machine translation and similar structured prediction problems.
+[![Build Status](https://travis-ci.org/redpony/cdec.svg?branch=master)](https://travis-ci.org/redpony/cdec)
+
## System requirements
- A Linux or Mac OS X system
- A C++ compiler implementing the [C++-11 standard](http://www.stroustrup.com/C++11FAQ.html) <font color="red"><b>(NEW)</b></font>
- Unfortunately, many systems have compilers that predate C++-11 support.
- - You may need to build your own C++ compiler or upgrade your operating system.
+ - You may need to build your own C++ compiler or upgrade your operating system's.
- [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.
@@ -13,25 +15,25 @@
## Building from a downloaded archive
-Instructions:
+If your system contains the required tools and libraries in the usual places, you should be able to build as simply as:
- ./configure
- make
- ./tests/run-system-tests.pl
+ ./configure
+ make -j4
+ ./tests/run-system-tests.pl
## Building from a git clone
-In addition to the standard `cdec` third party requirements, you will additionally need the following software:
+In addition to the standard `cdec` third party software requirements, you will additionally need the following software to work with the `cdec` source code directly from git:
- [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
+ autoreconf -ifv
+ ./configure
+ make -j4
+ ./tests/run-system-tests.pl
## Further information