summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Dyer <cdyer@allegro.clab.cs.cmu.edu>2015-04-02 00:55:13 -0400
committerChris Dyer <cdyer@allegro.clab.cs.cmu.edu>2015-04-02 00:55:13 -0400
commit4a8cc6a754c5078f40418a59b0c8bef4aa82d00c (patch)
treed92e4909438ca6f7c8c1b69234b2a545cffa5ae9
parent737ed7a7f932b1a7e40d2755bcdee6bc0aa2de63 (diff)
new instr
-rw-r--r--README.md26
1 files changed, 8 insertions, 18 deletions
diff --git a/README.md b/README.md
index 3cbc62c3..413eddac 100644
--- a/README.md
+++ b/README.md
@@ -5,34 +5,24 @@
## 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.
+- A C++ compiler implementing at least the [C++-11 standard](http://www.stroustrup.com/C++11FAQ.html)
+ - Some systems may have compilers that predate C++-11 support.
- 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`.
+ - If you build your own boost, you _must install it_ using `bjam install` (to install it into a customized location use `--prefix=/path/to/target`).
- 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/)
+- [cmake](http://www.cmake.org/) - <font color="red"><b>(NEW)</b></font>
-## Building from a downloaded archive
-
-If your system contains the required tools and libraries in the usual places, you should be able to build as simply as:
-
- ./configure
- make -j4
- ./tests/run-system-tests.pl
-
-## Building from a git clone
+## Building the software from a git clone
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:
+Build instructions:
- autoreconf -ifv
- ./configure
+ cmake .
make -j4
+ make test
./tests/run-system-tests.pl
## Further information