Changes between Version 15 and Version 16 of barSoftwareInstallation

Timestamp:

08/30/11 11:32:52 (13 years ago)

Author:

jkowalski

Comment:

documentation generation

barSoftwareInstallation

@@ -86 +86 @@
 }}}
 
-{{{#!comment
-then create directory where datasets will be stored:
-{{{
-mkdir -p /home/$USERNAME/3dbar/atlases
-}}}
-}}}
-
 Created directories have the following purposes:
   * **bin**: Holds all executable files, atlas parsers and auxiliary scripts
@@ -100 +93 @@
     * atlases/DATASET_NAME/caf : This is the directory where a CAF dataset is generated by specific parsers.
     * atlases/DATASET_NAME/reconstructions : The directory for reconstructed models.
+
+== Initial build ==
+=== Documentation ===
+In order to generate documentation execute:
+{{{
+make doc
+}}}
+
+The documentation for API can be viewed by opening '~/3dbar/doc/api/html/index.html'
+and the documentation for 3dBAR graphic interface can be viewed by opening
+'~/3dbar/doc/api/html/index.html'.
+
 
 {{{#!comment