Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix Git clone instructions to work out of the box. #823

Merged
merged 7 commits into from
Aug 26, 2021
Merged

Fix Git clone instructions to work out of the box. #823

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e046cea
Fix Git clone instructions to work out of the box. #821
varosi Aug 26, 2021
a017a3d
Adding some macOS prerequisites for installing crux-llvm
varosi Aug 26, 2021
a7368f1
Fix wording in README.md file
varosi Aug 26, 2021
b229306
Restore erased line in README.md file
varosi Aug 26, 2021
3ca3a06
Fixed an extra whitespace
varosi Aug 26, 2021
ae32799
Apply suggestions from code review
varosi-chaosgroup Aug 26, 2021
0d609cc
Update crux-llvm/README.md
varosi-chaosgroup Aug 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions crux-llvm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,14 @@ software:

* The Z3 SMT solver: <https://github.com/Z3Prover/z3/releases>

* The Clang compiler: <http:https://releases.llvm.org/download.html>
* The Clang compiler and LLVM toolchain: <http:https://releases.llvm.org/download.html>

If you are on macOS, one way to install LLVM is with [`brew`](https://brew.sh/).
To install LLVM with `brew`, run the following commands:
* `xcode-select --install`
* `brew install llvm`
* `echo 'export PATH="/usr/local/opt/llvm/bin:$PATH"' >> ~/.bash_profile`
* run `crux-llvm` in a new console to reload `.bash_profile`
varosi-chaosgroup marked this conversation as resolved.
Show resolved Hide resolved

We have tested `crux-llvm` most heavily with GHC 8.6.5, GHC 8.8.4, GHC
8.10.4, and `cabal` version 3.2.0.0. We recommend Yices 2.6.x, and Z3
Expand All @@ -31,9 +38,9 @@ work well, and any failures with versions in that range should be

The `crux-llvm` tool can be built by doing the following:

* Clone the `crucible` repository:
* Clone (incl. the submodules) the `crucible` repository:

git clone https://github.com/GaloisInc/crucible.git
git clone --recursive https://github.com/GaloisInc/crucible.git

* Build the `crux-llvm` package:

Expand Down