This is the README file for the VHDL makefile maker program.
After uncompressing and untaring, you should have the following
files :

-rwxr--r--  1 hemi         2165 May 25 14:08 README
drwxr-xr-x  2 hemi          512 Jun 11 14:26 doc
drwxr-xr-x  2 hemi          512 Apr 19 09:13 src

doc:
-rw-r--r--  1 hemi          364 Jun 11 14:25 example.vmkrrc
-rw-r--r--  1 hemi        98410 Apr 16 18:07 vmkr.doc.internal.ps
-rw-r--r--  1 hemi        47021 Apr 16 18:07 vmkr.doc.ps

src:
-rw-r--r--  1 hemi         7705 Apr 16 14:56 COPYING
-rwxr-xr-x  1 hemi          486 Apr 19 13:00 Makefile
-rwxr-xr-x  1 hemi        13100 Apr 16 15:11 back_ann.c
-rwxr-xr-x  1 hemi        55744 Jun 11 13:55 create_make.c
-rwxr-xr-x  1 hemi        18904 May  3 13:40 get_tokens.c
-rw-r--r--  1 hemi         9433 Jun 11 13:29 makegen.c
-rwxr-xr-x  1 hemi         2518 Jun 11 13:56 typedef.h
-rwxr-xr-x  1 hemi        21471 Jun 11 13:54 update.c
-rwxr--r--  1 hemi         6806 Jun 11 13:53 vmkr.man

To create the makefile maker, go to the src directory and type in
	make all
This will create an executable called vmkr.
This executable can then be moved to an appropriate bin.
Additionally, the man page, can be moved to the appropriate
directory where local man pages are kept (eg. /usr/local/man).

To use vmkr, PLEASE READ THE MAN PAGES!!!  NOTE NOTE NOTE
that you MUST have only one design unit per file, or else
vmkr may not work!  See the man pages for more info.

To add a new toolset, and its commands, you must modify the
following files :
	typedef.h
		- add the new toolset name
		- eg. #define NEWVENDOR	8
	create_make.c
		- modify the function build_libnames()
		  as required
	makegen.c
		- modify the main routine that goes
		  through the switches
	vmkr.man
		- update the man page to reflect new toolset

Finally, please note that what started out as a small, quick and
dirty program, has grown into a large, cumbersome set of files
that is often difficult to read.  I have placed lots of comments
for anyone interested in modifying the code.  If you wish to
foray vmkr, you will need the document "Internal workings of vmkr",
called doc/vmkr.doc.internal.ps.  (Good luck for anyone brave
enough to do this :-)