Skip to content

Commit 2ed8f2f

Browse files
authored
Doc improvements: supported platforms and versions (rust-lang#1969)
1 parent bc7b888 commit 2ed8f2f

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,9 @@ Kani verifies:
99
* The absence of panics (e.g., `unwrap()` on `None` values)
1010
* The absence of some types of unexpected behavior (e.g., arithmetic overflows)
1111

12-
## GitHub Action
13-
14-
Use Kani in your CI with `model-checking/kani@VERSION`. See the
15-
[GitHub Action section in the Kani
16-
book](https://model-checking.github.io/kani/install-github-ci.html)
17-
for details.
18-
1912
## Installation
2013

21-
To install the latest version of Kani, run:
14+
To install the latest version of Kani ([Rust 1.58+; Linux or Mac](https://model-checking.github.io/kani/install-guide.html)), run:
2215

2316
```bash
2417
cargo install --locked kani-verifier
@@ -54,6 +47,13 @@ Kani will then try to prove that all valid inputs produce acceptable outputs, wi
5447
Otherwise Kani will generate a trace that points to the failure.
5548
We recommend following [the tutorial](https://model-checking.github.io/kani/kani-tutorial.html) to learn more about how to use Kani.
5649

50+
## GitHub Action
51+
52+
Use Kani in your CI with `model-checking/kani-github-action@VERSION`. See the
53+
[GitHub Action section in the Kani
54+
book](https://model-checking.github.io/kani/install-github-ci.html)
55+
for details.
56+
5757
## Security
5858
See [SECURITY](https://github.com/model-checking/kani/security/policy) for more information.
5959

docs/src/install-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Kani offers an easy installation option on three platforms:
44

55
* `x86_64-unknown-linux-gnu` (Most Linux distributions)
66
* `x86_64-apple-darwin` (Intel Mac OS)
7-
* `aarch64-apple-darwin` (Apple M1)
7+
* `aarch64-apple-darwin` (Apple Silicon Mac OS)
88

99
Other platforms are either not yet supported or require instead that
1010
you [build from source](build-from-source.md). To use Kani in your
@@ -14,8 +14,8 @@ GitHub CI workflows, see [GitHub CI Action](./install-github-ci.md).
1414

1515
The following must already be installed:
1616

17-
* **Python version 3.6 or greater** and the package installer `pip`.
18-
* Rust installed via `rustup`.
17+
* **Python version 3.6 or newer** and the package installer `pip`.
18+
* Rust 1.58 or newer installed via `rustup`.
1919
* `ctags` is required for Kani's `--visualize` option to work correctly. [Universal ctags](https://ctags.io/) is recommended.
2020

2121
## Installing the latest version

0 commit comments

Comments
 (0)