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