diff options
author | Morgan Deters <mdeters@gmail.com> | 2012-10-03 21:41:15 +0000 |
---|---|---|
committer | Morgan Deters <mdeters@gmail.com> | 2012-10-03 21:41:15 +0000 |
commit | 7b7397c8fd04093e3e50666bc56954133805bd25 (patch) | |
tree | eef7b8ed929c47aa16b243b8fe9b91557e0ecdfe /examples/README | |
parent | c3e9112157320111c18b2984052abd9cd17127dc (diff) |
better documentation, allow examples to be installed, etc
Diffstat (limited to 'examples/README')
-rw-r--r-- | examples/README | 49 |
1 files changed, 33 insertions, 16 deletions
diff --git a/examples/README b/examples/README index 0861092e7..246388085 100644 --- a/examples/README +++ b/examples/README @@ -1,16 +1,33 @@ -These are examples of how to use CVC4 with each of its in-memory, library -interfaces. They are essentially "hello world" examples, and do not -fully demonstrate the interfaces, but function as a starting point to -using simple expressions and solving functionality through each library. - -These examples are built as a separate step. After building CVC4, you -can make the examples by running "make" from inside the examples -directory. With the default configuration, you'll find them in -builds/examples in the top-level source directory (if you configured -your own build directory, you'll find them there). - -Many of the examples (python, ocaml, ruby, etc.) do not need to be -compiled to run. These are not compiled by "make"---see the comments -in the files for ideas on how to run them. - --- Morgan Deters <mdeters@cs.nyu.edu> Wed, 16 Nov 2011 02:48:19 -0500 +This directory contains usage examples of CVC4's different language +bindings, library APIs, and also tutorial examples from the tutorials +available at http://cvc4.cs.nyu.edu/wiki/Tutorials + +*** Files named SimpleVC*, simple_vc* + +These are examples of how to use CVC4 with each of its library +interfaces (APIs) and language bindings. They are essentially "hello +world" examples, and do not fully demonstrate the interfaces, but +function as a starting point to using simple expressions and solving +functionality through each library. + +*** Installing example source code + +Examples are not automatically installed by "make install". If you +wish to install them, use "make install-examples" after you configure +your CVC4 source tree. They'll appear in your documentation +directory, under the "examples" subdirectory (so, by default, +in /usr/local/share/doc/cvc4/examples). + +*** Building examples + +Examples can be built as a separate step, after building CVC4 from +source. After building CVC4, you can run "make examples" (or just +"make" from *inside* the examples directory). You'll find the built +binaries in builds/examples (or just in "examples" if you configured a +build directory outside of the source tree). + +Many of the language bindings examples (python, ocaml, ruby, etc.) do +not need to be compiled to run. These are not compiled by +"make"---see the comments in the files for ideas on how to run them. + +-- Morgan Deters <mdeters@cs.nyu.edu> Wed, 03 Oct 2012 15:47:33 -0400 |