summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 16 insertions, 7 deletions
diff --git a/README.md b/README.md
index 42d9953c..8f335adb 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,16 @@
`cdec` is a research platform for machine translation and similar structured prediction problems.
+## 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.
+- [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 downloaded archive
Instructions:
@@ -8,13 +19,6 @@ Instructions:
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:
@@ -33,3 +37,8 @@ Instructions:
[For more information, refer to the `cdec` documentation](http://www.cdec-decoder.org)
+## Citation
+
+If you make use of cdec, please cite:
+
+C. Dyer, A. Lopez, J. Ganitkevitch, J. Weese, F. Ture, P. Blunsom, H. Setiawan, V. Eidelman, and P. Resnik. cdec: A Decoder, Alignment, and Learning Framework for Finite-State and Context-Free Translation Models. In *Proceedings of ACL*, July, 2010. [[bibtex](http://www.cdec-decoder.org/cdec.bibtex.txt)] [[pdf](http://www.aclweb.org/anthology/P/P10/P10-4002.pdf)]