2015-02-28 00:56:51 +00:00
< p align = center > < a href = "https://leanprover.github.io" > < img src = "https://leanprover.github.io/images/lean_logo.svg" alt = "logo" width = "300px" / > < / a > < / p >
2013-11-12 01:40:32 +00:00
< table >
< tr >
2014-10-29 00:22:03 +00:00
< th > License< / th > < th > Windows< / th > < th > Ubuntu< / th > < th > OS X< / th > < th > Coverage< / th > < th > Builds/Tests< / th > < th > Static Analysis< / th >
2013-11-12 01:40:32 +00:00
< / tr >
< tr >
2014-08-01 16:58:40 +00:00
< td > < a href = "LICENSE" > < img src = "https://img.shields.io/badge/license-APACHE_2-green.svg?dummy" title = "License" / > < / a > < / td >
2014-10-29 00:22:03 +00:00
< td > < a href = "https://travis-ci.org/soonhokong/lean-windows" > < img src = "https://travis-ci.org/soonhokong/lean-windows.png?branch=master" title = "Windows, x86_64-w64-mingw32-g++-4.8.2" / > < / a > < / td >
2014-04-29 22:31:29 +00:00
< td > < a href = "https://travis-ci.org/leanprover/lean" > < img src = "https://travis-ci.org/leanprover/lean.png?branch=master" title = "Ubuntu 12.04 LTS 64bit, g++-4.8 | clang++-3.3" / > < / a > < / td >
2013-11-12 01:40:32 +00:00
< td > < a href = "https://travis-ci.org/soonhokong/lean-osx" > < img src = "https://travis-ci.org/soonhokong/lean-osx.png?branch=master" title = "Mac OS X 10.8.2, g++-4.9" / > < / a > < / td >
2014-05-02 05:47:35 +00:00
< td > < a href = "https://coveralls.io/r/leanprover/lean?branch=master" > < img src = "https://coveralls.io/repos/leanprover/lean/badge.png?branch=master" / > < / a > < / td >
2014-05-05 15:26:39 +00:00
< td > < a href = "http://build.leanprover.net" > < img src = "https://leanprover.github.io/images/cdash.svg" / > < / a > < / td >
2014-05-03 03:27:50 +00:00
< td > < a href = "https://scan.coverity.com/projects/2153" > < img alt = "Coverity Scan Build Status" src = "https://scan.coverity.com/projects/2153/badge.svg" / > < / a > < / td >
2013-11-12 01:40:32 +00:00
< / tr >
< / table >
2013-09-04 04:55:40 +00:00
2014-10-29 00:22:03 +00:00
[](http://issuestats.com/github/leanprover/lean)
[](http://issuestats.com/github/leanprover/lean)
2013-09-13 17:01:40 +00:00
About
-----
2013-07-25 07:20:39 +00:00
2015-02-28 00:56:51 +00:00
- [Homepage ](https://leanprover.github.io )
2015-01-13 20:21:08 +00:00
- Theorem Proving in Lean: [HTML ](https://leanprover.github.io/tutorial/index.html ), [PDF ](http://leanprover.github.io/tutorial/tutorial.pdf )
2015-03-28 23:23:32 +00:00
- [Authors ](http://leanprover.github.io/people/ )
2015-02-28 00:56:51 +00:00
- [Standard Library ](library/library.md )
2015-03-05 02:06:39 +00:00
- [HoTT Library ](hott/hott.md )
2015-01-13 20:23:14 +00:00
- [Short Tutorial ](doc/lean/tutorial.org )
- [To Do list ](doc/todo.md )
2013-07-25 07:20:39 +00:00
2013-09-13 17:01:40 +00:00
Requirements
------------
2013-07-25 07:20:39 +00:00
2013-09-14 18:37:39 +00:00
- C++11 compatible compiler: [g++ ](http://gcc.gnu.org/ ) (version >= 4.8.1), or [clang++ ](http://clang.llvm.org/cxx_status.html ) (version >= 3.3)
2013-09-13 17:01:40 +00:00
- [CMake ](http://www.cmake.org )
- [GMP (GNU multiprecision library) ](http://gmplib.org/ )
- [MPFR (GNU MPFR Library) ](http://www.mpfr.org/ )
2013-11-08 18:43:52 +00:00
- [Lua 5.2 or 5.1 ](http://www.lua.org ), or [LuaJIT 2.0 ](http://luajit.org )
2013-09-13 17:01:40 +00:00
- (optional) [gperftools ](https://code.google.com/p/gperftools/ )
2013-12-10 01:45:31 +00:00
- (optional) [Boost ](http://www.boost.org ) (version >= 1.54), we can
build Lean using boost::thread instead of std::thread. When using
Boost, Lean can modify the thread stack size.
2013-11-08 18:43:52 +00:00
2013-09-13 17:01:40 +00:00
Installing required packages at
--------------------------------
2013-07-25 07:20:39 +00:00
2014-09-26 23:28:46 +00:00
_Windows_
- [MSys2 ](doc/make/msys2.md )
- [Cygwin ](doc/make/cygwin.md )
_Linux_
2013-09-13 17:01:40 +00:00
- [Ubuntu 12.04 ](doc/make/ubuntu-12.04.md )
- [Ubuntu 12.04 (detailed) ](doc/make/ubuntu-12.04-detailed.md )
- [Fedora 19 ](doc/make/fedora-19.md )
2014-09-26 23:28:46 +00:00
_OS X_
2014-08-24 01:15:51 +00:00
- [OS X 10.9 ](doc/make/osx-10.9.md )
2013-08-10 21:32:42 +00:00
2013-07-25 07:20:39 +00:00
Build Instructions
2013-09-13 17:01:40 +00:00
------------------
2013-08-18 03:51:26 +00:00
2013-09-13 17:01:40 +00:00
- [CMake + Make ](doc/make/cmake_make.md )
- [CMake + Ninja ](doc/make/cmake_ninja.md )
- [Faster builds with ccache ](doc/make/ccache.md )
2013-08-18 03:51:26 +00:00
2013-09-13 17:01:40 +00:00
Miscellaneous
-------------
2013-08-18 03:51:26 +00:00
2013-09-13 17:01:40 +00:00
- [Testing and Code Coverage ](doc/make/coverage.md )
- Building Doxygen Documentation: `doxygen src/Doxyfile`
2014-10-08 15:06:33 +00:00
- [Coding Style ](doc/coding_style.md )
2015-05-12 04:58:15 +00:00
- [Library Style Conventions ](doc/lean/library_style.org )
- [Git Commit Conventions ](doc/commit_convention.md )
2014-10-08 15:06:33 +00:00
- [Automatic Builds ](doc/make/travis.md )
- [Syntax Highlight Lean Code in LaTeX ](doc/syntax_highlight_in_latex.md )
