Skip to content

Commit 1b7c84a

Browse files
Add JBMC README
1 parent 03d6f5b commit 1b7c84a

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

jbmc/README.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
[![Build Status][travis_img]][travis] [![Build Status][appveyor_img]][appveyor]
2+
3+
About
4+
=====
5+
6+
JBMC is a Bounded Model Checker for Java programs. It supports
7+
checking for runtime exceptions and user-definde assertions.
8+
The verification is performed by unwinding the loops in the program
9+
and passing the resulting equation to a decision procedure.
10+
11+
[More info...](http://www.cprover.org/jbmc)
12+
13+
Versions
14+
========
15+
16+
Get the [latest release](https://github.com/diffblue/cbmc/releases)
17+
* Releases are tested and for production use.
18+
19+
Get the current *develop* version: `git clone https://github.com/diffblue/cbmc.git`
20+
* Develop versions are not recommended for production use.
21+
22+
Prerequisites
23+
============
24+
25+
JBMC compiles CBMC as part of its build process and as such has all the pre-requisites of CBMC. These can be viewed at: [diffblue/cbmc:COMPILING](http://github.com/diffblue/cbmc/blob/master/COMPILING)
26+
27+
Compilation
28+
===========
29+
30+
To compile you need to run the command:
31+
32+
```bash
33+
make -C jbmc/src
34+
```
35+
Output
36+
======
37+
38+
Compiling produces an executable called `jbmc` which by default can be found in `jbmc/src/jbmc/jbmc`
39+
40+
Reporting bugs and contributing to the code base
41+
================================================
42+
43+
See [CBMC](https://github.com/diffblue/cbmc/blob/develop/README.md))
44+
45+
License
46+
=======
47+
4-clause BSD license, see `LICENSE` file.
48+
49+
[travis]: https://travis-ci.org/diffblue/cbmc
50+
[travis_img]: https://travis-ci.org/diffblue/cbmc.svg?branch=develop
51+
[appveyor]: https://ci.appveyor.com/project/diffblue/cbmc/
52+
[appveyor_img]: https://ci.appveyor.com/api/projects/status/github/diffblue/cbmc?svg=true&branch=develop

0 commit comments

Comments
 (0)