Next: 3 Project Management
Up: YMLEditor Users Guide
Previous: 1 A Brief Overview
Subsections
2 Installing and Running
If you are reading
this documentation from the YMLEditor's online help system then you
can safely skip this section.
2.1 System Requirements
- The script ymleditor used to run the YMLEditor performs
various tasks such as creating new projects and opening external
files requires the bash command shell.
- The YMLEditor requires Java(tm) version 1.4.2 or better.
In order for the YMLEditor to find Java(tm) the java
executable must either be on your PATH or the JAVA_HOME
environment variable must be set to the root directory of your
Java(tm) installation. If java is both on your PATH and
JAVA_HOME is set, JAVA_HOME will take priority.
- In order to edit source code within the YMLEditor nedit
(optional) is required. nedit-nc or nc must be on
your path. nedit can be found at
http://www.nedit.org
If you would like to use a
different editor you can modify the ymleditor script.
- For graph auto-routing to work you must install GraphViz
(optional). The dot executable must be on your PATH.
GraphViz can be found at
http://www.graphviz.org/
- SESAME tools are also required. More specifically the sesamesim-config program must be on your PATH. This program
tells the ymleditor where SESAME is installed.
2.2 Installing
Once the requirements of the
previous section have been met you can install the YMLEditor simply by
untaring and uncompressing the distribution. This can be accomplished
with the following command:
tar xzvf ymleditor-x.x.x.tar.gz
This will create a directory called ymleditor-x.x.x, where x.x.x
is the version of the ymleditor you are installing.
2.3 Running
Once you have installed the
YMLEditor and all of its requirements you may run the program by
calling the script ymleditor which is in the root directory of
the YMLEditor installation.
2.4 Exiting
You can exit the YMLEditor either
by closing the main window or by selecting Exit from the Project menu. Make sure you first save your work.
Next: 3 Project Management
Up: YMLEditor Users Guide
Previous: 1 A Brief Overview
Joseph Coffland
2006-04-05