Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nick8325 committed Sep 11, 2017
1 parent ad8b838 commit a6d01ab
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions README
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
This is twee, a prover for equational problems.
This is twee, an equational theorem prover.

To install, run cabal install.
The version in this git repository is likely to be unstable!
To install the latest stable version, run:

Afterwards, invoke as twee nameofproblem.p. The problem should be in
TPTP format (http://www.tptp.org). You can find a few examples in the
tests directory. All axioms and conjectures must be equations, but you
can freely use types and quantifiers.
cabal install twee

Twee is experimental software, use at your own risk!
If you have LLVM installed, you can get a slightly faster version by
running:

cabal install twee -fllvm

If you really want the latest unstable version, run `cabal install` in
this repository. You will most likely need the latest git version of
Jukebox, from https://github.com/nick8325/jukebox, too - and things
may break from time to time.

Afterwards, run `twee nameofproblem.p`. The problem should be in TPTP
format (http://www.tptp.org). You can find a few examples in the
`tests` directory. All axioms and conjectures must be equations, but
you can freely use quantifiers. If it succeeds in proving your
problem, twee will print a human-readable proof.

0 comments on commit a6d01ab

Please sign in to comment.