[MOAB-dev] commit/MOAB: janehu: Added a README file into doc/ with instructions about how to generate docs.

[commits-noreply at bitbucket.org]

1 new commit in MOAB:

https://bitbucket.org/fathomteam/moab/commits/318157c87a47/
Changeset:   318157c87a47
Branch:      master
User:        janehu
Date:        2013-07-29 18:38:15
Summary:     Added a README file into doc/ with instructions about how to generate docs.

Affected #:  1 file

diff --git a/doc/README b/doc/README
new file mode 100644
index 0000000..76ed8b5
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,21 @@
+How to generate doxygen document for MOAB in Linux:
+
+-  Install doxygen, and include the doxygen installation path to PATH.
+
+-  After checking out moab from bitbucket, do following under moab directory:
+
+   autoreconf -fi
+   ./configure [options] --enable-docs --with-doxygen=DIR
+   make
+   make check
+   cd doc
+   doxygen user.dox
+
+(--ebable-docs indicates to check for doxygen installation under your given --with-doxygen directory or, if --with-doxygen is not given, under your PATH. If doxygen execuable is not found, it'll report error and exit configure.
+
+If you are sure doxygen is installed and put into PATH, you don't need to add --enable-docs or --with-doxygen, going to doc directory and directly applying "doxygen user.dox" should generate all the documents.)
+
+-  After doxygen is done, you should be able to open web browser, and view MOAB document at file://your_moab_dir/doc/html/index.html . 
+
+
+

Repository URL: https://bitbucket.org/fathomteam/moab/

--

This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.