IAC ReadDatamine Project
------------------------

This directory ( iac_proj/rd_dmine/ ) contains all the V code, source code,
HTML documentation, and installation information for the IAC project
"ReadDatamine".

The directory should be placed into your existing project directory, which
should already contain the IAC Project File structure, i.e., the iac_proj/,
iac_lib/ and v/ directories.

The file INSTALL contains information on how to edit the existing IAC
files: a single line addition to the iac_proj/iac_proj.v file, to add the
new ReadDatamine project, and additions to two files in the iac_lib/
directory, to link appropriate objects to the top-level IAC library page.

Once the files have been correctly installed, the low-level module of the new
project may be compiled. If you opt to leave the process unspecified, it will
by default use the "express" process. Doing so means the module may be
compiled by using one of the following commands in the top-level directory of
your project (whilst AVS/Express is not running):

	base -comp_proc express -exit
or
	make -f express.mk

	Using the 'make' command, requires that the express.mk file already
exists, and has been updated accordingly.

	If you modify the ReadDatamine project, and elect to specify the process
as "user" or another user-defined process, then the module may be compiled
without having to exit the AVS/Express application. Use the following command
in the VCP to compile the module:

	$compile IAC_PROJ.ReadDatamine.ReadDatamineMods

	Users of the Developer's Edition may select the module in the 
relevant Templates library, and choose 'compile' from the Project menu.


Files
-----

The following files can be found in the iac_proj/twave/ directory.

INSTALL 	Contains installation instructions for editing the iac_proj.v
		and iac_lib/ files. This file should not be edited as the
		future installation script will use this file.

rd_dmine.v	Creates the IAC_PROJ.ReadDatamine template library.

rd_dmods.v	Creates the ReadDatamineMods library containing the low-level
		module ReadDatamineCore and the parameter block ReadDatamineParams.

rd_dmacs.v	Creates the ReadDatamineMacs library containing the user interface
		macro ReadDatamineUI, the functional macro ReadDatamineFunc, the
		utility macro extract_field and the user macro read_datamine.

rd_dapps.v	Creates the TextureWaveApps library containing the example
		application ReadDatamineEg.

rd_dmine.cxx	The C++ source code for the ReadDatamineCore module.

dmfile.cxx	The C++ source code for the objects used by rd_dmine.cxx
dmfile.hxx

dm.hxx		C++ Header containing utility definitions and macros.

rd_dmine.html	HTML documentation for the read_datamine macro, and modules.

README		This file.


Generated Files
---------------

When the project is compiled, the following files will be generated. Once
completed, you may safely remove these files; any future recompilations
will regenerate these files.

gen.hxx		AVS/Express generated header file.

gen.cxx		AVS/Express generated source code.

rd_dmine.o/obj	Intermediate object files.
dmfile.o/obj

