Skip to content

Commit 82db78c

Browse files
committed
Change the readme.md to only include Rust build commands, now that we no longer build with corrosion
1 parent 1c2fa36 commit 82db78c

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

src/libcprover-rust/readme.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,21 @@ This folder contains the implementation of the Rust API of the CProver (CBMC) pr
44

55
## Building instructions
66

7-
There are two ways to build the project:
8-
9-
1. As part of the CBMC project (using `cmake`) by building CBMC with the flag
10-
`-DWITH_RUST_API=ON`. The outcome of this process is a compilation artefact
11-
`libcprover-x.y.z.a` under the `<build>/lib` directory.
12-
2. By executing `cargo build` under this (`src/libcprover-rust`) directory.
13-
14-
For this to work, you need to supply two environment variables to the
15-
project:
16-
17-
* `CBMC_LIB_DIR`, for selecting where the `libcprover-x.y.z.a` is located
18-
(say, if you have downloaded a pre-packaged release which contains
19-
the static library), and
20-
* `CBMC_VERSION`, for selecting the version of the library to link against
21-
(this is useful if you have multiple versions of the library in the same
22-
location and you want to control which version you compile against).
7+
To build the Rust project you need the Rust language toolchain installed
8+
(you can install from [rustup.rs](https://rustup.rs)).
9+
10+
With that instaled, you can execute `cargo build` under this (`src/libcprover-rust`)
11+
directory.
12+
13+
For this to work, you need to supply two environment variables to the
14+
project:
15+
16+
* `CBMC_LIB_DIR`, for selecting where the `libcprover-x.y.z.a` is located
17+
(say, if you have downloaded a pre-packaged release which contains
18+
the static library), and
19+
* `CBMC_VERSION`, for selecting the version of the library to link against
20+
(this is useful if you have multiple versions of the library in the same
21+
location and you want to control which version you compile against).
2322

2423
As an example, a command sequence to build the API through `cargo` would look
2524
like this (assuming you're executing these instructions from the root level

0 commit comments

Comments
 (0)