Clarify some parts of install-guide.md (rust-lang#758)

* Clarify some parts of install-guide.mc
celinval · Jan 19, 2022 · 5aa0089 · 5aa0089
1 parent 36e7d82
commit 5aa0089
Showing 1 changed file with 4 additions and 5 deletions.
diff --git a/kani-docs/src/install-guide.md b/kani-docs/src/install-guide.md
@@ -2,14 +2,12 @@
 
 Kani must currently be built from source.
 
-In general, the following dependencies are required:
+In general, the following dependencies are required. Note: These dependencies may be installed by running the CI scripts shown below and there is no need to install them separately, for their respective OS.
 
 1. Cargo installed via rustup
 2. [CBMC](https://github.com/diffblue/cbmc) (>= 5.48.0)
 3. [CBMC Viewer](https://github.com/awslabs/aws-viewer-for-cbmc) (>= 2.6)
 
-Note: These dependencies may be installed by running the CI scripts shown below and there is no need to install them separately, for their respective OS.
-
 ## Installing on Ubuntu 20.04
 
 The simplest way to install (especially if you're using a fresh VM) is following our CI scripts:
@@ -23,6 +21,7 @@ git submodule update --init
 ./scripts/setup/ubuntu-20.04/install_cbmc.sh
 ./scripts/setup/install_viewer.sh 2.6
 ./scripts/setup/install_rustup.sh
+source $HOME/.cargo/env
 ```
 
 ## Installing on Mac OS
@@ -38,6 +37,7 @@ git submodule update --init
 ./scripts/setup/macos-10.15/install_cbmc.sh
 ./scripts/setup/install_viewer.sh 2.6
 ./scripts/setup/install_rustup.sh
+source $HOME/.cargo/env
 ```
 
 ## Building and testing Kani
@@ -57,8 +57,7 @@ Perform one-time build configuration:
 Then build kani-compiler executable:
 
 ```
-cd src/kani-compiler
-cargo build
+( cd src/kani-compiler && cargo build )
 ```
 
 Then, optionally, run the regression tests: