Readme update

This commit is contained in:
Guillaume Bury 2016-12-26 12:24:07 +01:00
parent 35c99df753
commit 109ddd7a73

View file

@ -1,7 +1,7 @@
# MSAT [![Build Status](https://travis-ci.org/Gbury/mSAT.svg?branch=master)](https://travis-ci.org/Gbury/mSAT)
MSAT is an OCaml library that features a modular SAT-solver and some
extensions (including SMT). This is **work in progress**.
extensions (including SMT).
It derives from [Alt-Ergo Zero](http://cubicle.lri.fr/alt-ergo-zero).
@ -16,6 +16,21 @@ This program is distributed under the Apache Software License version
See https://gbury.github.io/mSAT/
## INSTALLATION
### Via opam
Once the package is on [opam](http://opam.ocaml.org), just `opam install msat`.
For the development version, use:
opam pin add msat https://github.com/Gbury/mSAT.git
### Manual installation
You will need ocamlfind and ocamlbuild. The command is:
make install
## USAGE
### Generic SAT/SMT Solver
@ -60,20 +75,3 @@ as shown in the following code :
let _ = Sat.solve () (* Should return (Sat.Unsat _) *)
```
## INSTALLATION
### Via opam
Once the package is on [opam](http://opam.ocaml.org), just `opam install msat`.
For the development version, use:
opam pin add msat https://github.com/Gbury/mSAT.git
### Manual installation
You will need ocamlfind. The command is:
make install