Difference between revisions of "Docintro"

From VNUML-WIKI
Jump to: navigation, search
(1.8 becomes official, 1.7 becomes old)
m
Line 3: Line 3:
 
VNUML documentation is made of the following documents (updated to 1.8):
 
VNUML documentation is made of the following documents (updated to 1.8):
  
* [[tutorial|Tutorial]]
+
* [[Tutorial|Tutorial]]
* [[installation|Installation Guide]]
+
* [[Installation|Installation Guide]]
* [[usermanual|User Manual]]
+
* [[Usermanual|User Manual]]
* [[reference|Language Reference]]
+
* [[Reference|Language Reference]]
 
* [[FAQ|Frequently Asked Questions (FAQ)]]
 
* [[FAQ|Frequently Asked Questions (FAQ)]]
 
* [[howto|Howtos]]  
 
* [[howto|Howtos]]  

Revision as of 01:47, 22 May 2007

VNUML Documentation

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

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: