OVERVIEW OF THE XBEL DIRECTORY TREE

This document gives a high-level overview of the XBel directory
tree. XBel is the mother of all our multi-valued model-checking
projects and contains three major tools: 

  - XChek, a multi-valued model-checker

  - TLQSolver, a query-checker based on XChek

  - YASM, a symbolic software model-checker with automatic abstraction
  refinement that uses Belnap-logic based abstraction and a lot of
  infrastructure from XChek.

A quick summary of the top-level directory

  - bin: contains the scripts for setting the build environment and
         running the tools
      ./bin/xc -- a script to start XChek and TLQSolver
      ./bin/yasm -- a script to start Yasm
      ./bin/env.sh -- a script to setup the build environment

  - runtime: third-party executables used by our tools. This directory
      is created and populated through get-runtime target in build.xml

  - build: automatically created directory that hosts all Java
           compiled class files

  - csrc: libraries that are written in C/C++
      ./csrc/cvcl       SWIG-based Java wrapper for CVCLite
      ./csrc/libjcudd   Hand-written Java wrapper for CUDD
      ./csrc/cudd       SWIG-based Java wrapper for CUDD

  - doc: documentation directory
     ./OVERVIEW:  this file
     ./tlqsolver: documentation for TLQSolver
     ./yasm:      documentation for Yasm
     ./javadoc:   JavaDoc documentation, generated automatically 
                  by ant's javadoc target
     
  - jsrc: the source code of everything written in Java. See
          doc/javadoc for further documentation
   
  - junit: JUnit unit tests and supporting files

  - lib:   3rd-party libraries
      ./libCudd.so     CUDD interface produced by csrc/cudd
      ./libJavaCVC.so  CVCL interface produced by csrc/cvcl
      ./libjcudd.so    CUDD interface produced by csrc/libjcudd
      ./buildLib       other Java packages used by the tools

  - log-cfg: Configuration for Log4J. Deprecated.
  
  - logs: Directory to keep logs generated by Log4J. Deprecated.

  - play: Everything under the sun that is part of the project but
          does not belong anywhere. 

  - tmp:  Place your temporary files here
  
  - tools: 3rd-Party tools. Deprecated.


