180 lines
5.2 KiB
Markdown
180 lines
5.2 KiB
Markdown
[](https://travis-ci.org/leodemoura/lean)
|
|
Ubuntu 12.04 LTS 64bit, g++-4.8 | clang++-3.3
|
|
|
|
[](https://travis-ci.org/soonhokong/lean-osx)
|
|
Mac OS X 10.8.2, g++-4.9
|
|
|
|
[](https://travis-ci.org/soonhokong/lean-windows)
|
|
Windows, x86_64-w64-mingw32-g++-4.8.1
|
|
|
|
[[Result of Build/UnitTest/Coverage/Dynamic Analysis]][cdash]
|
|
|
|
[cdash]: http://cmacslab2.modck.cs.cmu.edu/CDash-2-0-2/index.php?project=Lean
|
|
|
|
Requirements
|
|
============
|
|
|
|
- C++11 compatible compiler
|
|
- GMP (GNU multiprecision library)
|
|
http://gmplib.org/
|
|
- MPFR (GNU MPFR Library)
|
|
http://www.mpfr.org/
|
|
- (optional) gperftools
|
|
https://code.google.com/p/gperftools/
|
|
- cmake
|
|
http://www.cmake.org
|
|
|
|
Install Packages on Ubuntu 12.04 LTS
|
|
------------------------------------
|
|
|
|
Instructions for installing gperftools on Ubuntu
|
|
|
|
sudo add-apt-repository ppa:agent-8131/ppa
|
|
sudo apt-get update
|
|
sudo apt-get dist-upgrade
|
|
sudo apt-get install libgoogle-perftools-dev
|
|
|
|
Instructions for installing gcc-4.8 (C++11 compatible) on Ubuntu
|
|
|
|
sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
|
|
sudo update-alternatives --remove-all gcc
|
|
sudo update-alternatives --remove-all g++
|
|
sudo apt-get update
|
|
sudo apt-get install g++-4.8 -y
|
|
sudo apt-get upgrade -y && sudo apt-get dist-upgrade -y
|
|
|
|
Instructions for installing clang-3.3 (C++11 compatible) on Ubuntu
|
|
|
|
sudo add-apt-repository ppa:h-rayflood/llvm
|
|
sudo apt-get update
|
|
sudo apt-get dist-upgrade
|
|
sudo apt-get install clang-3.3 clang-3.3-doc
|
|
|
|
Note that you [still need][clang_cxx_status] to have g++-4.8's C++
|
|
runtime library to support some C++11 features that we are using.
|
|
|
|
You can specify the C++ compiler to use by using ``-DCMAKE_CXX_COMPILER``
|
|
option. For example
|
|
|
|
cmake -DCMAKE_BUILD_TYPE=DEBUG -DCMAKE_CXX_COMPILER=clang++-3.3 ../../src
|
|
|
|
[clang_cxx_status]: http://clang.llvm.org/cxx_status.html
|
|
|
|
Install Packages on Fedora 19
|
|
-----------------------------
|
|
|
|
Instructions for installing git, cmake, mpfr, gmp, gperftools on Fedora
|
|
|
|
sudo yum install -y git cmake mpfr-devel gmp-devel gperftools-devel
|
|
|
|
Instructions for installing gcc-4.8 (C++11 compatible) on Fedora
|
|
|
|
sudo yum install -y gcc-c++
|
|
|
|
Instructions for installing clang-3.3 (C++11 compatible) on Fedora
|
|
|
|
sudo yum install -y clang-devel
|
|
|
|
Install Packages on OS X 10.8
|
|
-----------------------------
|
|
We assume that you are using [homebrew][homebrew], "The missing package manager for OS X".
|
|
|
|
[homebrew]: http://brew.sh
|
|
|
|
Instructions for installing gperftools on OS X 10.8
|
|
|
|
$ brew install gperftools
|
|
|
|
Instructions for installing gcc-4.8 (C++11 compatible) on OS X 10.8
|
|
|
|
$ brew tap homebrew/versions
|
|
$ brew install gcc48
|
|
|
|
Instructions for installing clang-3.3 (C++11 compatible) on OS X 10.8
|
|
|
|
$ brew install llvm --with-clang --with-asan
|
|
|
|
Install Packages on Cygwin
|
|
--------------------------
|
|
Just run cygwin setup.exe (http://cygwin.com/install.html) and make sure that you have installed g++ 4.8.1 (or greater), cmake, gmp and libmpfr.
|
|
We have tested Lean using Cygwin for 64-bit versions of Windows.
|
|
|
|
Build Instructions
|
|
==================
|
|
|
|
Using [CMake][cmake] + Make
|
|
---------------------
|
|
Instructions for DEBUG build
|
|
|
|
mkdir -p build/debug
|
|
cd build/debug
|
|
cmake -DCMAKE_BUILD_TYPE=DEBUG ../../src
|
|
make
|
|
|
|
Instructions for RELEASE build
|
|
|
|
mkdir -p build/release
|
|
cd build/release
|
|
cmake -DCMAKE_BUILD_TYPE=RELEASE ../../src
|
|
make
|
|
|
|
Using [CMake][cmake] + [Ninja][ninja]
|
|
-------------------------------
|
|
[CMake 2.8.11][cmake] supports [Ninja][ninja] build system using
|
|
``-G`` option. [Some people report][ninja_work] that using
|
|
[Ninja][ninja] can reduce the build time, esp when a build is
|
|
incremental.
|
|
|
|
[ninja_work]: https://plus.google.com/108996039294665965197/posts/SfhrFAhRyyd
|
|
|
|
Instructions for DEBUG build
|
|
|
|
mkdir -p build/debug
|
|
cd build/debug
|
|
cmake -DCMAKE_BUILD_TYPE=DEBUG -G Ninja ../../src
|
|
ninja
|
|
|
|
Instructions for RELEASE build
|
|
|
|
mkdir -p build/release
|
|
cd build/release
|
|
cmake -DCMAKE_BUILD_TYPE=RELEASE -G Ninja ../../src
|
|
ninja
|
|
|
|
[cmake]: http://www.cmake.org/
|
|
[ninja]: http://martine.github.io/ninja/
|
|
|
|
Instructions for Testing and Measuring Code Coverage
|
|
====================================================
|
|
|
|
To measure [code coverage][cover], compile TESTCOV build using g++:
|
|
|
|
mkdir -p build/testcov
|
|
cd build/testcov
|
|
cmake -DCMAKE_BUILD_TYPE=TESTCOV -DCMAKE_CXX_COMPILER=g++-4.8 -G Ninja ../../src
|
|
ninja
|
|
|
|
and run test cases:
|
|
|
|
ctest
|
|
|
|
and collect coverage data using [lcov][lcov] and [gcov][gcov]:
|
|
|
|
lcov -c -b ../../src -d . -o cov.info --no-external --gcov-tool gcov-4.8
|
|
|
|
and generate HTML output:
|
|
|
|
genhtml cov.info --output-directory lcov
|
|
|
|
Note: make sure that the version of ``gcov`` matches with the one of
|
|
``g++``. Also try to use the latest ``lcov`` if you have a problem
|
|
with the existing one.
|
|
|
|
[gcov]: http://gcc.gnu.org/onlinedocs/gcc/Gcov.html
|
|
[lcov]: http://ltp.sourceforge.net/coverage/lcov.php
|
|
[cover]: https://dl.dropboxusercontent.com/u/203889738/lcov/index.html
|
|
|
|
Instructions for Building Doxygen Documentation
|
|
===============================================
|
|
|
|
doxygen src/Doxyfile
|