Ensure disequality splits are processed as lemmas (#4380)
[cvc5.git] / INSTALL.md
index 55bd4aef519b3e46f7b3aa293f040ece23d33286..17d31fe1a4ccb8b93cf9abfc246312eb54d732fa 100644 (file)
@@ -1,4 +1,4 @@
-CVC4 prerelease version 1.7.
+CVC4 prerelease version 1.8.
 ============================
 
 ## Building CVC4
@@ -12,7 +12,7 @@ CVC4 prerelease version 1.7.
     make install     # to install into the prefix specified above
 
 All binaries are built into `<build_dir>/bin`, the CVC4 library is built into
-`<build_dir>/src`.
+`<build_dir>/lib`.
 
 ## Supported Operating Systems
 
@@ -23,6 +23,21 @@ On macOS, we recommend using Homebrew (https://brew.sh/) to install the
 dependencies.  We also have a Homebrew Tap available at
 https://github.com/CVC4/homebrew-cvc4 .
 
+### Cross-compiling for Windows
+
+Cross-compiling CVC4 with Mingw-w64 can be done as follows:
+
+```
+  HOST=x86_64-w64-mingw32 ./contrib/get-win-dependencies
+  ./configure --win64 --static <configure options...>
+
+  cd <build_dir>   # default is ./build
+  make             # use -jN for parallel build with N threads
+```
+
+The built binary `cvc4.exe` is located in `<build_dir>/bin` and the CVC4 library
+can be found in `<build_dir>/lib`.
+
 ## Build dependencies
 
 The following tools and libraries are required to build and run CVC4.  
@@ -34,6 +49,7 @@ compatible.
 - [CMake >= 3.1](https://cmake.org)
 - [GNU Bash](https://www.gnu.org/software/bash/)
 - [Python >= 2.7](https://www.python.org)
+  + module [toml](https://pypi.org/project/toml/)
 - [GMP v4.2 (GNU Multi-Precision arithmetic library)](https://gmplib.org)
 - [libantlr3c v3.2 or v3.4 (ANTLR parser generator C support library)](http://www.antlr3.org/)
 - [Java >= 1.6](https://www.java.com)
@@ -94,7 +110,7 @@ Configure CVC4 with `configure.sh --lfsc` to build with this dependency.
 ### SWIG >= 3.0.x (Simplified Wrapper and Interface Generator)
 
 SWIG 3.0.x (and a JDK) is necessary to build the Java API.
-See [Language Bindings](language-bindings) below for build instructions.
+See [Language Bindings](#language-bindings) below for build instructions.
 
 ### CLN >= v1.3 (Class Library for Numbers)