GaloisInc/cryptol
1
1
Fork 0
mirror of https://github.com/GaloisInc/cryptol.git synced 2024-12-01 08:32:23 +03:00
Code Issues Projects Releases Wiki Activity

readme updates

Browse Source 
clarify CVC4 dependency and tweak wording around checking an installation
This commit is contained in:
Adam C. Foltzer 2014-04-21 12:01:18 -07:00
parent bca8d997f5
commit 51cb27555a
1 changed files with 23 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -33,6 +33,8 @@ extract to a location of your choice. Windows binaries are distributed
as an `.msi` installer package which places a shortcut to the Cryptol
interpreter in the Start menu.
## Getting CVC4
Cryptol currently depends on the
[CVC4 SMT solver](http://cvc4.cs.nyu.edu/) to solve constraints during
typechecking, and as the default solver for the `:sat` and `:prove`
@ -70,7 +72,7 @@ versions is to:
1. Run `cabal install cabal-install`
1. Add cabal-install's binary path to your PATH variable (usually `~/.cabal/bin`)
1. Add cabal-install's binary path to your `PATH` variable (usually `~/.cabal/bin`)
Some supporting non-Haskell libraries are required to build
Cryptol. Most should already be present for your operating system, but
@ -79,6 +81,8 @@ you may need to install the following:
- [The GNU Multiple Precision Arithmetic Library (GMP)](https://gmplib.org/)
- [ncurses](https://www.gnu.org/software/ncurses/)
You'll also need [CVC4](#getting-cvc4) installed when running Cryptol.
## Building Cryptol
From the Cryptol source directory, run:
@ -105,31 +109,24 @@ binary at `.cabal-sandbox/bin/cryptol` in your source directory. You
can either use that binary directly, or use the results of `tarball`
or `dist` to install Cryptol in a location of your choice.
## Verifying your Installation
# Checking your Installation
Run Cryptol, and at the prompt type:
_ _
___ _ __ _ _ _ __ | |_ ___ | |
/ __| '__| | | | '_ \| __/ _ \| |
| (__| | | |_| | |_) | || (_) | |
\___|_| \__, | .__/ \__\___/|_|
|___/|_| version 2.0.424
Loading module Cryptol
Cryptol> :prove True
If Cryptol responds
Q.E.D.
then your installation is correct. If it prints something like
then Cryptol is installed correctly. If it prints something like
*** An error occurred.
*** Unable to locate executable for cvc4
*** Executable specified: "cvc4"
then make sure you've installed CVC4, and that the binary is on your `PATH`.
then make sure you've installed [CVC4](#getting-cvc4), and that the
binary is on your `PATH`.
# Contributing
@ -139,18 +136,17 @@ to get involved.
## Users
If you write Cryptol programs that you think would benefit the community, fork the GitHub repository, and
add them to the `examples/contrib` directory and submit
a pull request.
If you write Cryptol programs that you think would benefit the
community, fork the GitHub repository, and add them to the
`examples/contrib` directory and submit a pull request.
We host a Cryptol mailing list, which
you can [join here](http://community.galois.com/mailman/listinfo/cryptol-users).
If you run into a bug in Cryptol, if something
doesn't make sense in the documentation, if you
think something could be better, or if you
just have a cool use of Cryptol that you'd like to share with us, use the issues page on
[GitHub](https://github.com/GaloisInc/cryptol), or
If you run into a bug in Cryptol, if something doesn't make sense in
the documentation, if you think something could be better, or if you
just have a cool use of Cryptol that you'd like to share with us, use
the issues page on [GitHub](https://github.com/GaloisInc/cryptol), or
send email to <cryptol@galois.com>.
## Developers