Difference between revisions of "Docintro"
(entry for 1.8 docs) |
|||
| Line 15: | Line 15: | ||
'''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>): | ||
| + | |||
| + | * v1.8: [[tutorial_1.8|tutorial]], [[installation_1.8|installation]], [[usermanual_1.8|user manual]], [[reference_1.8|language reference]] | ||
| + | |||
Old documentation: | Old documentation: | ||
Revision as of 17:01, 28 March 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 (not finished!):
Old documentation:
- v1.6: tutorial, installation, user manual, language reference.
- v1.5: tutorial, installation, user manual, language reference.
- v1.4: tutorial, installation, user manual, language reference.
- v1.3: tutorial, installation, user manual, language reference.
