Skip to content

Commit

Permalink
Update README with GHC version, Windows notes
Browse files Browse the repository at this point in the history
Closed #288
Closes #1462
  • Loading branch information
Aaron Tomb committed Oct 6, 2021
1 parent 59182bd commit 43b72e1
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ To build SAWScript and related utilities from source:

* Ensure that you have the `cabal` and `ghc` executables in your
`PATH`. If you don't already have them, we recommend using `ghcup`
to install them: <https://www.haskell.org/ghcup/>
to install them: <https://www.haskell.org/ghcup/>. We recommend
Cabal 3.4 or newer, and GHC 8.8 or 8.10.

* Ensure that you have the C libraries and header files for
`terminfo`, which generally comes as part of `ncurses` on most
Expand Down Expand Up @@ -70,7 +71,7 @@ SAW can analyze LLVM programs (usually derived from C, but potentially
for other languages). The only tool strictly required for this is a
compiler that can generate LLVM bitcode, such as `clang`. However,
having the full LLVM tool suite available can be useful. We have tested
SAW with LLVM and `clang` versions from 3.5 to 11.0, as well as the
SAW with LLVM and `clang` versions from 3.5 to 12.0, as well as the
version of `clang` bundled with Apple Xcode. We welcome bug reports on
any failure to parse bitcode from LLVM versions in that range.

Expand All @@ -79,6 +80,11 @@ will be possible for all language constructs. There are various
instructions that are not supported during verification. However,
any failure during `llvm_load_module` should be considered a bug.

## Notes on Windows

If you have trouble loading the SAW REPL on Windows, try invoking it
with the `--no-color` option.

## Related Packages

Many dependencies are automatically downloaded into `deps/` when you
Expand Down

0 comments on commit 43b72e1

Please sign in to comment.