Difference between revisions of "Docintro"

From VNUML-WIKI
Jump to: navigation, search
Line 13: Line 13:
  
 
If you want to know how VNUML works internally or plan to modify it, vnumlparser.pl code itself it a good documentation source for developers. Please, let us know about any modifications you do, in order to include them in future versions.
 
If you want to know how VNUML works internally or plan to modify it, vnumlparser.pl code itself it a good documentation source for developers. Please, let us know about any modifications you do, in order to include them in future versions.
 +
 +
IMPORTANT NOTE: documentation (specially the Tutorial) has been written considering VNUML installed VNUML with the .deb package. Therefore, /usr/share and /var/ are used as prefix in file asbolute pathnames. If you have installed from .tar.gz, you have to use /usr/local/share and /var/local. However, note that installation scripts in the .tar.gz are smart enough to set the right ubications in the examples in /usr/local/share examples.
 +
 +
  
 
Old documentation:
 
Old documentation:

Revision as of 04:36, 10 February 2007

VNUML Documentation

VNUML documentation is made of the following documents (updated to 1.7):

If you come to VNUML for the first time, you should start with the tutorial to get an overview about VNUML philosophy and fetaures. A FAQ is also provided.

If you want to know how VNUML works internally or plan to modify it, vnumlparser.pl code itself it a good documentation source for developers. Please, let us know about any modifications you do, in order to include them in future versions.

IMPORTANT NOTE: documentation (specially the Tutorial) has been written considering VNUML installed VNUML with the .deb package. Therefore, /usr/share and /var/ are used as prefix in file asbolute pathnames. If you have installed from .tar.gz, you have to use /usr/local/share and /var/local. However, note that installation scripts in the .tar.gz are smart enough to set the right ubications in the examples in /usr/local/share examples.


Old documentation: