From 504da2e215bd002ba763b7f102ddbd05917bc0d8 Mon Sep 17 00:00:00 2001 From: Aina Niemetz Date: Thu, 14 Mar 2019 15:17:31 -0700 Subject: [PATCH] Improve INSTALL instructions. (#2866) --- INSTALL.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index dc0de6cb4..55bd4aef5 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,19 @@ CVC4 prerelease version 1.7. ============================ +## Building CVC4 + + ./contrib/get-antlr-3.4 # download and build ANTLR + ./configure.sh # use --prefix to specify a prefix (default: /usr/local) + # use --name= for custom build directory + cd # default is ./build + make # use -jN for parallel build with N threads + make check # to run default set of tests + make install # to install into the prefix specified above + +All binaries are built into `/bin`, the CVC4 library is built into +`/src`. + ## Supported Operating Systems CVC4 can be built on Linux and macOS. For Windows, CVC4 can be cross-compiled @@ -23,13 +36,14 @@ compatible. - [Python >= 2.7](https://www.python.org) - [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) Some features, such as the theory of floating-point numbers, require [optional dependencies](optional-dependencies) (see below). ### Installing libantlr3c: ANTLR parser generator C support library -For libantlr3c, you can use the script contrib/get-antlr-3.4. +For libantlr3c, you can use the script `contrib/get-antlr-3.4`. This will download, patch, and install libantlr3c. If you're on a 32-bit machine, or if you have difficulty building @@ -155,18 +169,6 @@ provided with CVC4. See [Testing CVC4](#Testing-CVC4) below for more details. -## Building CVC4 - - ./configure.sh # use --prefix to specify a prefix (default: /usr/local) - # use --name= for custom build directory - cd # default is ./build - make # use -jN for parallel build with N threads - make check # to run default set of tests - make install # to install into the prefix specified above - -All binaries are built into `/bin`, the CVC4 library is built into -`/src`. - ## Language bindings CVC4 provides a complete and flexible C++ API (see `examples/api` for examples). -- 2.30.2