diff --git a/README.md b/README.md index fb1102a795..2b4f7cf1fb 100644 --- a/README.md +++ b/README.md @@ -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: + to install them: . 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 @@ -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. @@ -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