Welcome to THUD, a cycle-oriented scheme-based RTL simulation environment.
See file COPYING for license information.  See also self-explanatory files
NEWS, THANKS, BUGS, TODO and RANDOM.

This file has the following sections: description; dependencies; installation.


=============
 Description
=============

  THUD is a cycle-oriented scheme-based register transfer level (RTL)
  simulation environment.  The design is expressed in THUD hardware
  description language (HDL), which supports basic 1/0/x operators and
  hierarchical instantiation.  THUD can be used in batch mode or through
  one of its interactive faces.

  Primitives are provided for session management; file format translation;
  scheduling; data structure examination; compilation; HDL generation; and
  of course, simulation.  Additionally, the entire Scheme development
  environment afforded by Guile is present.  The distribution includes a
  small test suite; documentation in Info and HTML formats; and some
  examples.


==============
 Dependencies
==============

  THUD requires a Guile that can handle `(make-hash-table #:size N)',
  and that provides the following modules:

   (ice-9 accumulate)
   (ice-9 and-let-star)
   (ice-9 getopt-long)
   (ice-9 gumm)
   (ice-9 pretty-print)
   (ice-9 rdelim)
   (ice-9 string-fun)
   (srfi srfi-1)
   (srfi srfi-13)

  At time of writing (early 2008), this basically indicates Guile 1.4.x:
  <http://www.gnuvola.org/software/guile/>, although the author holds on to
  the hope that a future "official" Guile will be able to host THUD.


==============
 Installation
==============

  (1) Unpack the distribution tarball.  The created subdirectory will
      always have a version number (indicated here by "X.Y").

	gzip -dc thud-X.Y.tar.gz | tar xf -

  (2) Configure to your system.  This looks for some things, notably Guile
      and Emacs.  The latter is not required, but if found, will be used
      to make THUD run faster.

	cd thud-X.Y
	./configure --help
	./configure		# default prefix is /usr/local

  (3) Build.  This may include compilation of THUD modules by Hobbit.
      As of version 0.21, you must use GNU make (sometimes available as
      gmake).

	make

      At this point you can do a "make check" to make sure things are ok.
      If this fails (non-zero exit value), please submit a bug report by
      sending the output of "make check DEBUG=1" to the maintainer.

  (4) Install.

	make install

      This process does the following copies, making directories and
      setting permission bits as needed.

	what				to where
	------------------------------	----------------------------
	thud, thgen executables		PREFIX/bin
	info format documentation	PREFIX/info
	runtime files			PREFIX/lib/thud/
	elisp source files		PREFIX/share/emacs/site-lisp

      At this point, THUD is installed and you can run it from anywhere
      (as long as the directory PREFIX/bin is in your path).  The build
      tree is free to return to chaos.

  (5) Send feedback.  THUD is an experiment, so emperical data from users
      is invaluable to its continuing evolution.  Who knows, we may even
      see the mythical 1.0 some day...


==================
 README ends here