JHDL 0.3.34
(C) 2003 Brigham Young University

INSTALLATION INSTRUCTIONS

Software Requirements:
* Java SDK (Software Development Kit) 1.3.0 or later
  http://java.sun.com/
* Jakarta Ant build tool 1.5 or later
  http://jakarta.apache.org/ant/
* OPTIONAL: IBM's Jikes Compiler 1.15 or later
  http://ibm.com/developerworks/opensource/jikes/
* OPTIONAL: Apache's Xerces XML parser version 1.4.3 only
  http://xml.apache.org/xerces-j/

Building JHDL:
1. Make sure you have Java installed correctly.  Compiling a simple
   "HelloWorld.java" should demonstrate this.  Both java and javac
   should be in your command path.
2. Make sure you have Ant installed correctly.  Ant may require you to
   set the JAVA_HOME and/or ANT_HOME environment variables
   appropriately.
3. OPTIONAL: To compile classes in the package byucc.jhdl.util.xmac,
   you must have version 1.4.3 of Apache's Xerces XML parser.  (We are
   currently working on supporting other versions of Xerces, including
   Xerces 2.)  The easiest way to include Xerces in your classpath is
   to place it in the lib subdirectory of your Ant installation.
   Xerces can even be used as a replacement parser for the default XML
   parser included with the Ant distribution.
4. Go into the @name@_0.3.34 directory.
5. Execute Ant.  The build.xml file is automatically targetted.
6. Ant will create a classes directory and a lib directory.  The
   compiled JHDL classes will be placed in the classes directory and
   a JHDL.jar will be created in the lib directory.  The JHDL.jar file
   contains all of the classes and resources from the classes
   directory and the resources directory.

**********************************************************************
*  IMPORTANT NOTE ABOUT JHDL'S XMAC AND APACHE'S XERCES XML PARSER:  *
If you do not have the Xerces XML parser in your classpath, the build
process will fail unless you remove the Java files in the
byucc/jhdl/util/xmac subdirectory of the src directory.  If you
prefer, you may also modify the build.xml file to exclude files from
that directory.
The xmac classes are used to create new cell libraries for use with
JHDL.  (This distribution of JHDL includes pre-built Java source code
files for cell libraries that target various families of Xilinx FPGA
devices.)  The xmac classes are an optional component of the JHDL
suite and are not required for normal design and simulation targetting
using existing technology-specific libraries.
**********************************************************************
