Skip to content

Commit 5bc7381

Browse files
committed
Add a basic README in the api folder
1 parent 6850b84 commit 5bc7381

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

cpp_api/readme.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# The CPROVER C++ API
2+
3+
This folder includes the interface and the implementation of a new C++-based
4+
API for the CProver libraries. The aim is for this to be able to be used by
5+
clients to drive all of the verification pipeline without the need to invoke
6+
any of the associated tools.
7+
8+
## Implementation
9+
10+
The major part of the implementation of the API is in [`api.cpp`](api.cpp).
11+
To use the API as it stands, you need to include the header [`api.h`](api.h)
12+
in your program, and link against the resultant shared-object from the CProver
13+
build process (`libcprover-api.a`).
14+
15+
## Example
16+
17+
An example for driving the API in its current form is in the file [`call_bmc.cpp`](call_bmc.cpp),
18+
which we are also using as a binary driver for testing the API.

0 commit comments

Comments
 (0)