Skip to content

Commit 1495e73

Browse files
authored
Clarify installation instructions (#4023)
1. Remove the reference to Python 2. Clarify what the installation steps do Resolves #4008 By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.
1 parent 6acad2f commit 1495e73

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/src/install-guide.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,24 @@ GitHub CI workflows, see [GitHub CI Action](./install-github-ci.md).
1414

1515
The following must already be installed:
1616

17-
* **Python version 3.7 or newer** and the package installer `pip`.
1817
* Rust 1.58 or newer installed via `rustup`.
1918

2019
## Installing the latest version
2120

22-
To install the latest version of Kani, run:
21+
Installing the latest version of Kani is a two step process.
2322

23+
First, download and build Kani's installer package using:
2424
```bash
2525
cargo install --locked kani-verifier
26+
```
27+
This will build and place in `~/.cargo/bin` (in a typical environment) the `kani` and `cargo-kani` binaries.
28+
29+
Next, run the installer to download and install the prebuilt binaries as well as supporting libraries and data:
30+
```bash
2631
cargo kani setup
2732
```
2833

29-
This will build and place in `~/.cargo/bin` (in a typical environment) the `kani` and `cargo-kani` binaries.
30-
The second step (`cargo kani setup`) will download the Kani compiler and other necessary dependencies, and place them under `~/.kani/` by default.
34+
The second step will download the Kani compiler and other necessary dependencies, and place them under `~/.kani/` by default.
3135
A custom path can be specified using the `KANI_HOME` environment variable.
3236

3337
## Installing an older version

0 commit comments

Comments
 (0)