aboutsummaryrefslogtreecommitdiffstats
path: root/docs/readme.txt
blob: e50b98068c3ae02660cebf35aad650b148bab1c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
*** Documentation access ***

Open ./docs/index.html to open the start page or ./docs/html/index.html in
order to access directly the doxigen documentation.

*** Documentation build procedure ***

The following software must be installed:
- Doxygen 1.7.3 or later.
- Graphviz 2.26.3 or later. The ./bin directory must be specified in the path
  in order to make Graphviz accessible by Doxygen.

Build procedure:
- Run Doxywizard.
- Load ./docs/Doxyfile from Doxywizard.
- Start.