######################################################
##                       README                     ##
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~##
##                      28-02-2005                  ##
######################################################

   This is an empty ARTIS application project. It consists on
a set of files written in XML (class.xml, class.xsd, control.xml,
entities.xml, metaclass.xml), where the different parts of the
ARTIS application are specified, and a set of templates which are
needed to compile and execute the final application  (main.c,
Makefile and rtload).


- THE XML FILES

   The XML files found in the directory are initially empty; that
is, they have to be filled before being able to generate the C
source code to be compiled and executed. The easiest way to write
these files is using the TNT tool-kit, which is also avaliable
with this version of ARTIS, and which can be run just by executing
'runTNT' from a teminal window. However, it is also possible to
write the XML code directly, without using TNT.

   
- C SOURCE CODE GENERATION AND COMPILATION PROCESS

   Once all the XML files have been filled, the source code of the
application has to be generated. In order to do this, thare are a set
of parsers avaliable with this version of ARTIS. All the parsers have
to be called from a terminal:

   artis_entities_parser entities.xml
   artis_kdm_parser class.xml
   artis_mrules_parser control.xml
   artis_metaclass_parser metaclass.xml

   Anyway, the Makefile in the directory is also prepared to do this
automatically, so that it's enough to call to 'make parse' to get all
these files parsed

   It's also possible to parse and compile the resulting files automatically
doing 'make', although most of the times you'd probably prefer editing the
C source code before compiling it.

- EXECUTION OF THE ARTIS APPLICATION

   To execute the generated application you only have to invoke the 'rtload'
script (also in the application directory). This script loads all the modules
that compound the application in the correct order and launches the main program.
It also takes care of unloading the different modules in the correct order

   The usage of rtload is this:
   
   rtload <execution time> <trace file>
   
   Execution time is expressed in seconds and the trace file is the file where all
tracing information corresponding to the execution of the ARTIS application will
be written (providing that ARTIS has been compiled with trace support).

   The 'rtload' script can be modified to suit better the application that is being
designed, just in case that it needs additional modules (like the serial port driver
for RT-Linux, rt_com).