Skip to content

Commit

Permalink
Update README quickstart section
Browse files Browse the repository at this point in the history
  • Loading branch information
adpaco-aws committed Sep 24, 2021
1 parent 23496ef commit aaa02a6
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,32 @@ The Rust Model Checker (RMC) aims to be a bit-precise model-checker for Rust.

## Project Status
RMC is currently in the initial development phase.
It **does not yet support all rust language features**.
It **does not yet support all Rust language features**.
We are working to extend our support of language features.
If you encounter issues when using RMC we encourage you to
[report them to us](https://github.com/model-checking/rmc/issues/new/choose).

## Quickstart

1. Install all dependencies required for upstream-rust, as per the
[README](UPSTREAM-README.md#building-on-a-unix-like-system).
The [RMC Installation Guide](https://model-checking.github.io/rmc/install-guide.html)
shows how to quickly install all RMC dependencies using our setup scripts.

1. Install CBMC.
CBMC has prebuilt releases
[available for major platforms](https://github.com/diffblue/cbmc/releases).
RMC currently works with CBMC versions 5.26 or greater.
If you want to build CBMC from source, follow
[the cmake instructions from the CBMC repo](https://github.com/diffblue/cbmc/blob/develop/COMPILING.md#working-with-cmake).
We recommend using `ninja` as the CBMC build system.
These are the steps to follow:

1. Install [CBMC Viewer](https://github.com/awslabs/aws-viewer-for-cbmc/releases/latest).
1. Install the dependencies needed for [`rustc`](https://github.com/rust-lang/rust),
CBMC](https://github.com/diffblue/cbmc) and
[CBMC Viewer](https://github.com/awslabs/aws-viewer-for-cbmc/releases/latest).
The [RMC Installation Guide](https://model-checking.github.io/rmc/install-guide.html)
shows how to quickly install all them using our setup scripts.

1. Configure RMC.
We recommend using the following options:
```
./configure \
--debuginfo-level-rustc=2 \
--enable-debug \
--set=llvm.download-ci-llvm=true \
--set=rust.debug-assertions-std=false \
--set=rust.deny-warnings=false \
--set=rust.incremental=true
--set=rust.deny-warnings=false
```

1. Build RMC
Expand Down

0 comments on commit aaa02a6

Please sign in to comment.