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