examples/README

   1 This directory contains usage examples of CVC4's different language
   2 bindings, library APIs, and also tutorial examples from the tutorials
   3 available at http://cvc4.cs.nyu.edu/wiki/Tutorials
   4
   5 *** Files named SimpleVC*, simple_vc*
   6
   7 These are examples of how to use CVC4 with each of its library
   8 interfaces (APIs) and language bindings.  They are essentially "hello
   9 world" examples, and do not fully demonstrate the interfaces, but
  10 function as a starting point to using simple expressions and solving
  11 functionality through each library.
  12
  13 *** Installing example source code
  14
  15 Examples are not automatically installed by "make install".  If you
  16 wish to install them, use "make install-examples" after you configure
  17 your CVC4 source tree.  They'll appear in your documentation
  18 directory, under the "examples" subdirectory (so, by default,
  19 in /usr/local/share/doc/cvc4/examples).
  20
  21 *** Building examples
  22
  23 Examples can be built as a separate step, after building CVC4 from
  24 source.  After building CVC4, you can run "make examples" (or just
  25 "make" from *inside* the examples directory).  You'll find the built
  26 binaries in builds/examples (or just in "examples" if you configured a
  27 build directory outside of the source tree).
  28
  29 Many of the language bindings examples (python, ocaml, ruby, etc.) do
  30 not need to be compiled to run.  These are not compiled by
  31 "make"---see the comments in the files for ideas on how to run them.
  32
  33 -- Morgan Deters <mdeters@cs.nyu.edu>  Wed, 03 Oct 2012 15:47:33 -0400