Difference between revisions of "Docintro"

From VNUML-WIKI
Jump to: navigation, search
(entry for 1.8 docs)
m
Line 16: Line 16:
 
'''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.
 
'''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.
  
On going documentation (<strong><span style="color:red">not finished!</span></strong>):
+
On going documentation (<strong><span style="color:red">now finished</span></strong>):
  
 
* v1.8: [[tutorial_1.8|tutorial]], [[installation_1.8|installation]], [[usermanual_1.8|user manual]], [[reference_1.8|language reference]]
 
* v1.8: [[tutorial_1.8|tutorial]], [[installation_1.8|installation]], [[usermanual_1.8|user manual]], [[reference_1.8|language reference]]

Revision as of 00:16, 14 May 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.

On going documentation (now finished):


Old documentation: