From 991daa54e8138939088d134011176a52120d0a1b Mon Sep 17 00:00:00 2001 From: Chris Dyer Date: Tue, 2 Oct 2012 01:10:44 -0400 Subject: new readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md (limited to 'README.md') 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) + -- cgit v1.2.3 From 8a10fd2856e13489cc10d2c683ecbce687f1e5ff Mon Sep 17 00:00:00 2001 From: Chris Dyer Date: Tue, 2 Oct 2012 14:09:30 -0400 Subject: better readme --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d19fda3e..d89e9558 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,12 @@ Build `cdec`: You will need the following libraries / tools: - boost - GNU Autotools - GNU Flex +- [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/) ## Further information -- cgit v1.2.3 From a1640eaaf3735c16a7109ac0f72e071a1b5e3359 Mon Sep 17 00:00:00 2001 From: Chris Dyer Date: Sat, 9 Mar 2013 00:32:41 -0500 Subject: fix readme --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) (limited to 'README.md') 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) -- cgit v1.2.3 From 1eefe83275709d03409d09ef413fe7a28e75b8d7 Mon Sep 17 00:00:00 2001 From: Chris Dyer Date: Sat, 9 Mar 2013 00:33:27 -0500 Subject: fix readme --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index c282d468..b5349836 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ In addition to the standard `cdec` third party requirements, you will additional - [Autoconf / Automake / Libtool](http://www.gnu.org/software/autoconf/) - Older versions of GNU autotools may not work properly. + autoreconf -ifv ./configure make -- cgit v1.2.3 From 604e830942d9bb27c73b22c64019f1cc848fbbd3 Mon Sep 17 00:00:00 2001 From: Chris Dyer Date: Sat, 9 Mar 2013 00:34:21 -0500 Subject: fix readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index b5349836..42d9953c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ ## Building from a downloaded archive +Instructions: + ./configure make ./tests/run-system-tests.pl @@ -20,6 +22,8 @@ In addition to the standard `cdec` third party requirements, you will additional - [Autoconf / Automake / Libtool](http://www.gnu.org/software/autoconf/) - Older versions of GNU autotools may not work properly. +Instructions: + autoreconf -ifv ./configure make -- cgit v1.2.3