f-cpu/vhdl/tools.desc/INSTALL.txt
created Sun Jun 23 01:15:30 CEST 2002 by whygee@f-cpu.org
updated Sun Jun 23 22:59:17 CEST 2002

This little package is made of a bash
script which contains the description
of several VHDL tools. There is nothing
to compile but a few steps things will
be done by the script when it is first
run.

* This script is located in a specific
directory to avoid confusion, allow
packaging and updates. However the
compilation scripts might not reside
in this directory : you must take care
of the current path etc.

* You usually source it from your main
compilation script (which selects the
files to compile and the entity and
architecture to simulate), so it is
parsed only once. Then, when all the
necessary variables are set, call
"vhdl_compile".

* The script determines the list of
installed tools with a detection step.
It then saves the result in a small file
in the current directory. If you don't
want to run all the tools everytime,
you can modify this file or define an
environment variable.

* Take care of the paths : all the VHDL
tools must be reacheable from $PATH and
the script is usually called with a
relative path. Usually, the top-level
scripts will take care of this but
remember this when you run it manually.


Warnings :
This tool might evolve quickly and new
features can be added. Don't hesitate
to hack into the files to perform tests
and correct possible bugs. As i tested
the tools on my own computer only, i
can only say that it works there. If
it doesn't work for you, read the file
"README.txt" which explains how the
script works (in case you have not
understood it by reading it).

Bugs or enhancements can be submitted
back to me (whygee@f-cpu.org) or to the
f-cpu@seul.org mailing list (as long as
maintainance is done there).
