summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMorgan Deters <mdeters@gmail.com>2012-09-22 21:10:51 +0000
committerMorgan Deters <mdeters@gmail.com>2012-09-22 21:10:51 +0000
commite2611a54c5479086df0c4a80f56597aae80b5c4e (patch)
treeb0d98600bd70147f28197883d3481614b87d76f6 /README
parent8b106b77c11d12d16abac845ed704845ef888bd2 (diff)
Separate public-facing and internal-facing interfaces to Statistics.
The external interface (e.g., what's answered by ExprManager::getStatistics() and SmtEngine::getStatistics()) is a snapshot of the current statistics (rather than a reference to the actual StatisticsRegistry). The StatisticsRegistry is now internal-only. However, it's built as a convenience library so that the parser and driver can use it too (by re-linking against it). This is part of the ongoing effort to clean up the public interface. (this commit was certified error- and warning-free by the test-and-commit script.)
Diffstat (limited to 'README')
-rw-r--r--README29
1 files changed, 20 insertions, 9 deletions
diff --git a/README b/README
index 37c285639..65c2d6fec 100644
--- a/README
+++ b/README
@@ -2,13 +2,14 @@ This is a prerelease version of CVC4.
*** Quick-start instructions
-To build, you'll need reasonably new automake, autoconf, and libtool
-installed (see below). Execute,
-
- ./autogen.sh
./configure
make
+(To build from a Subversion checkout, you'll need reasonably new
+automake, autoconf, and libtool installed (see below). The
+"configure" script isn't in the repository, so run "./autogen.sh"
+first to produce it. Then proceed as above.)
+
You can then "make install" to install in the prefix you gave to
the configure script (/usr/local by default). ** You should run
"make check" ** before installation to ensure that CVC4 has been
@@ -20,14 +21,14 @@ easily detects this problem (by showing a number of FAILed test cases).
It is ok if the unit tests aren't run as part of "make check", but all
system tests and regression tests should pass without incident.
+To build API documentation, use "make doc". Documentation is produced
+under doc/ but is not installed by "make install".
+
To build a source release, use "make dist"; this will include the
configure script and all the bits of automake/autoconf/libtool that
are necessary for an independent install. You'll find the resulting
tarball in builds/cvc4-${VERSION}.tar.gz.
-To build documentation, use "make doc". Documentation is produced
-under doc/ but is not installed by "make install".
-
*** Dependencies
The following tools and libraries are required to run CVC4. Versions
@@ -37,7 +38,17 @@ GNU C and C++ (gcc and g++), reasonably recent versions
GNU Make
GNU Bash
GMP v4.2 (GNU Multi-Precision arithmetic library)
-libantlr3c v3.2 (ANTLR parser generator)
+libantlr3c v3.2 or v3.4 (ANTLR parser generator)
+The Boost C++ base libraries
+
+For libantlr3c, you can use the convenience script in
+contrib/get-antlr-3.4 --this will download, patch, and install
+libantlr3c. On a 32-bit machine, or if you have difficulty
+building libantlr3c (or difficulty getting CVC4 to link against
+it later), you may need to remove the --enable-64bit part in the
+script. (If you're curious, the manual instructions are at
+http://church.cims.nyu.edu/wiki/Developer%27s_Guide#ANTLR3 .)
+
Optional: CLN v1.3 (Class Library for Numbers)
Optional: CUDD v2.4.2 (Colorado University Decision Diagram package)
Optional: GNU Readline library (for an improved interactive experience)
@@ -80,7 +91,7 @@ includes a diff of all changes made to cudd makefiles.
*** Build dependencies
The following tools and libraries are required to build CVC4 from
-scratch.
+scratch (i.e., from the repository rather than from a source tarball).
Automake v1.11
Autoconf v2.61
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback