Update README according to the new website (#3438)
[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 If you are using CVC4 in your work, or incorporating it into software of your
17 own, we invite you to send us a description and link to your
18 project/software, so that we can link it on our [Third Party
19 Applications](https://cvc4.github.io/third-party-applications.html) page.
20
21 CVC4 is intended to be an open and extensible SMT engine. It can be used as a
22 stand-alone tool or as a library. It has been designed to increase the
23 performance and reduce the memory overhead of its predecessors. It is written
24 entirely in C++ and is released under an open-source software license (see file
25 [COPYING](https://github.com/CVC4/CVC4/blob/master/COPYING)).
26
27
28 Website
29 -------------------------------------------------------------------------------
30 CVC4's website is available at:
31 http://cvc4.cs.stanford.edu/
32
33 Documentation
34 -------------------------------------------------------------------------------
35 Documentation for users of CVC4 is available at:
36 http://cvc4.cs.stanford.edu/
37
38 Documentation for developers is available at:
39 https://github.com/CVC4/CVC4/wiki/Developer-Guide
40
41 Download
42 -------------------------------------------------------------------------------
43
44 The latest version of CVC4 is available on GitHub:
45 https://github.com/CVC4/CVC4
46
47 Source tar balls and binaries for releases and latest stable builds of the
48 [master branch](https://github.com/CVC4/CVC4) on GitHub can be
49 found [here](http://cvc4.cs.stanford.edu/downloads).
50
51
52 Build and Dependencies
53 -------------------------------------------------------------------------------
54
55 CVC4 can be built on Linux and macOS. For Windows, CVC4 can be cross-compiled
56 using Mingw-w64.
57
58 For detailed build and installation instructions on these platforms,
59 see file [INSTALL.md](https://github.com/CVC4/CVC4/blob/master/INSTALL.md).
60
61
62 Bug Reports
63 -------------------------------------------------------------------------------
64
65 If you need to report a bug with CVC4, or make a feature request, please visit
66 our bugtracker at our [GitHub issues](https://github.com/CVC4/CVC4/issues)
67 page. We are very grateful for bug reports, as they help us improve CVC4.
68
69
70 Contributing
71 -------------------------------------------------------------------------------
72
73 Please refer to our [contributing guidelines](CONTRIBUTING.md).
74
75
76 Authors
77 -------------------------------------------------------------------------------
78
79 For a full list of authors, please refer to the
80 [AUTHORS](https://github.com/CVC4/CVC4/blob/master/AUTHORS) file.