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 *** Targetted examples
  14
  15 The "api" directory contains some more specifically-targetted
  16 examples (for bitvectors, for arithmetic, etc.).  The "api/java"
  17 directory contains the same examples in Java.
  18
  19 *** Installing example source code
  20
  21 Examples are not automatically installed by "make install".  If you
  22 wish to install them, use "make install-examples" after you configure
  23 your CVC4 source tree.  They'll appear in your documentation
  24 directory, under the "examples" subdirectory (so, by default,
  25 in /usr/local/share/doc/cvc4/examples).
  26
  27 *** Building examples
  28
  29 Examples can be built as a separate step, after building CVC4 from
  30 source.  After building CVC4, you can run "make examples".  You'll
  31 find the built binaries in builds/examples (or just in "examples" if
  32 you configured a build directory outside of the source tree).
  33
  34 -- Morgan Deters <mdeters@cs.nyu.edu>  Tue, 24 Dec 2013 09:12:59 -0500