README: Remove project leaders, history.
[cvc5.git] / README.md
1 [![License: BSD](
2 https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](
3 https://opensource.org/licenses/BSD-3-Clause)
4 [![Build Status](
5 https://travis-ci.org/CVC4/CVC4.svg?branch=master)](
6 https://travis-ci.org/CVC4/CVC4)
7
8 CVC4
9 ===============================================================================
10
11 CVC4 is a tool for determining the satisfiability of a first order formula
12 modulo a first order theory (or a combination of such theories). It is the
13 fourth in the Cooperating Validity Checker family of tools (CVC, CVC Lite,
14 CVC3) but does not directly incorporate code from any previous version.
15
16 CVC4 is intended to be an open and extensible SMT engine. It can be used as a
17 stand-alone tool or as a library. It has been designed to increase the
18 performance and reduce the memory overhead of its predecessors. It is written
19 entirely in C++ and is released under an open-source software license (see file
20 [COPYING](https://github.com/CVC4/CVC4/blob/master/COPYING)).
21
22
23 Website
24 -------------------------------------------------------------------------------
25
26 More information about CVC4 is available at:
27 http://cvc4.cs.stanford.edu/
28
29 Download
30 -------------------------------------------------------------------------------
31
32 The latest version of CVC4 is available on GitHub:
33 https://github.com/CVC4/CVC4
34
35 Source tar balls and binaries for releases and latest stable builds of the
36 [master branch](https://github.com/CVC4/CVC4) on GitHub can be
37 found [here](http://cvc4.cs.stanford.edu/downloads).
38
39
40 Build and Dependencies
41 -------------------------------------------------------------------------------
42
43 CVC4 can be built on Linux and macOS. For Windows, CVC4 can be cross-compiled
44 using Mingw-w64.
45
46 For detailed build and installation instructions on these platforms,
47 see file [INSTALL.md](https://github.com/CVC4/CVC4/blob/master/INSTALL.md).
48
49
50 Getting Started
51 -------------------------------------------------------------------------------
52
53 We recommend that you visit our CVC4 tutorials online at:
54
55 http://cvc4.cs.stanford.edu/wiki/Tutorials
56
57 for help getting started using CVC4.
58
59 If you need help with using CVC4, please refer to
60 [http://cvc4.stanford.edu#technical-support](
61 http://cvc4.stanford.edu#technical-support).
62
63 If you are using CVC4 in your work, or incorporating it into software of your
64 own, we'd like to invite you to leave a description and link to your
65 project/software on our [Third Party
66 Applications](http://cvc4.cs.stanford.edu/wiki/Public:Third_Party_Applications).
67
68
69 Bug Reports
70 -------------------------------------------------------------------------------
71
72 If you need to report a bug with CVC4, or make a feature request, please visit
73 our bugtracker at our [GitHub issues](https://github.com/CVC4/CVC4/issues)
74 page. We are very grateful for bug reports, as they help us improve CVC4.
75
76
77 Contributing
78 -------------------------------------------------------------------------------
79
80 Please refer to our [contributing guidelines](CONTRIBUTING.md).
81
82
83 Authors
84 -------------------------------------------------------------------------------
85
86 For a full list of authors, please refer to the
87 [AUTHORS](https://github.com/CVC4/CVC4/blob/master/AUTHORS) file.