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