WRENCH documentation: installation instructions

README.md

@@ -8,12 +8,12 @@
 
 ### Prerequisites
 
-  - Install **SimGrid** - version 3.17 or superior (http://simgrid.gforge.inria.fr/)
-  - Install **Lemon C++** library - version 1.3.1 or superior (http://lemon.cs.elte.hu/)
-  - Install **PugiXML** - version 1.8 or superior (http://pugixml.org/)
-  - Install **JSON for Modern C++** - version 2.1.1 or superior (https://github.com/nlohmann/json)
-  - Install **Google Test** - version 1.8 or superior (https://github.com/google/googletest) _(only required for running test cases)_
-  - Install **Doxygen** - version 1.8 or superior (www.doxygen.org) _(only required for generating documentation)_
+  - [SimGrid](http://simgrid.gforge.inria.fr/) - version 3.17 or superior
+  - [Lemon C++ library](http://lemon.cs.elte.hu/) - version 1.3.1 or superior 
+  - [PugiXML](http://pugixml.org/) - version 1.8 or superior 
+  - [JSON for Modern C++](https://github.com/nlohmann/json) - version 2.1.1 or superior 
+  - [Google Test](https://github.com/google/googletest) - version 1.8 or superior (only required for running test cases)
+  - [Doxygen](http://www.doxygen.org) - version 1.8 or superior (only required for generating documentation)
 
 #### Compiler
 

doc/index.md

@@ -1,6 +1,10 @@
 Overview                        {#mainpage}
 ============
 
+@WRENCHUserDoc <div class="doc-type">User Documentation</div> @endWRENCHUserDoc
+@WRENCHDeveloperDoc  <div class="doc-type">Developer Documentation</div> @endWRENCHDeveloperDoc
+@WRENCHInternalDoc  <div class="doc-type">Internal Documentation</div> @endWRENCHInternalDoc
+
 [TOC]
 
 ![Workflow Management System Simulation Workbench](images/logo-vertical.png)

doc/install.md

@@ -0,0 +1,76 @@
+Installing WRENCH                  {#install}
+============
+
+@WRENCHUserDoc <div class="doc-type">User Documentation</div> @endWRENCHUserDoc
+@WRENCHDeveloperDoc  <div class="doc-type">Developer Documentation</div> @endWRENCHDeveloperDoc
+@WRENCHInternalDoc  <div class="doc-type">Internal Documentation</div> @endWRENCHInternalDoc
+
+[TOC]
+
+# Prerequisites #                 {#install-prerequisites}
+_______
+
+- **CMake** - version 3.2.3 or superior
+
+And, one of the following:
+- **g++** - version 5 or superior
+- **clang** - version 3.6 or superior
+
+
+## Dependencies ##                  {#install-prerequisites-dependencies}
+
+- [SimGrid](http://simgrid.gforge.inria.fr/) - version 3.17 or superior
+- [Lemon C++ library](http://lemon.cs.elte.hu/) - version 1.3.1 or superior 
+- [PugiXML](http://pugixml.org/) - version 1.8 or superior 
+- [JSON for Modern C++](https://github.com/nlohmann/json) - version 2.1.1 or superior 
+- [Google Test](https://github.com/google/googletest) - version 1.8 or superior (only required for running test cases)
+- [Doxygen](http://www.doxygen.org) - version 1.8 or superior (only required for generating documentation)
+
+
+# Source Install #                  {#install-source}
+_______
+
+
+## Building WRENCH ##               {#install-source-build}
+
+You can download the _@WRENCHRelease.tar.gz_ archive from the 
+[GitHub releases](https://github.com/wrench-project/wrench/releases) page. 
+
+~~~~~~~~~~~~~{.sh}
+tar xf @WRENCHRelease.tar.gz
+cd @WRENCHRelease
+cmake .
+make
+make install
+~~~~~~~~~~~~~
+
+If you want to stay on the bleeding edge, you should get the latest git version, and recompile it as you would do for an official archive.
+
+~~~~~~~~~~~~~{.sh}
+git clone https://github.com/wrench-project/wrench
+~~~~~~~~~~~~~
+
+
+## Existing Compilation Targets ##  {#install-source-targets}
+
+In most cases, compiling and installing WRENCH is enough:
+
+~~~~~~~~~~~~~{.sh}
+make
+make install # try "sudo make install" if you don't have the permission to write
+~~~~~~~~~~~~~
+
+In addition, several compilation targets are provided in WRENCH.
+
+~~~~~~~~~~~~~{.sh}
+make doc               # Builds WRENCH documentation
+make unit_tests        # Builds WRENCH unit tests
+~~~~~~~~~~~~~
+
+
+If you want to see what is really happening, try adding VERBOSE=1 to your compilation requests:
+
+~~~~~~~~~~~~~{.sh}
+make VERBOSE=1
+~~~~~~~~~~~~~
+

doc/layout/customdoxygen.css

@@ -483,3 +483,19 @@ span.SRScope {
     display:inline;
   }
 }
+
+.doc-type {
+    float: right;
+    position: absolute;
+    right: 0;
+    top: 0;
+    background: #666;
+    -webkit-border-radius: 5px;
+    -moz-border-radius: 5px;
+    border-radius: 5px;
+    /*margin:10px;*/
+    color: #fff;
+    padding: 15px;
+    font: italic 16px Helvetica;
+}
+

doc/layout/header.html

@@ -32,6 +32,7 @@
     <!-- SmartMenus jQuery plugin -->
 </head>
 <body>
+
 <nav class="navbar navbar-default" role="navigation">
     <div class="container">
         <div class="navbar-header">
@@ -40,8 +41,19 @@
                 $projectnumber
             </a>
         </div>
+        <div id="main-nav" class="nav navbar-nav navbar-right">
+            <ul class="sm sm-dox nav navbar-nav navbar-right" id="main-menu">
+                <li><a href="index.html">Overview</a></li>
+                <li><a href="install.html">Installation</a></li>
+                <li><a href="annotated.html">API Reference</a></li>
+                <li style="float: right">
+                    <input type="hidden" id="MSearchField">
+                </li>
+            </ul>
+        </div>
     </div>
 </nav>
+
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
     <div class="content" id="content">
         <div class="container">

tools/doxygen/Doxyfile.in

@@ -238,7 +238,13 @@ TAB_SIZE               = 4
 # "Side Effects:". You can put \n's in the value part of an alias to insert
 # newlines.
 
-ALIASES                =
+ALIASES                = "WRENCHRelease=wrench-@WRENCH_RELEASE_VERSION@" \
+                         "WRENCHUserDoc=\if USER" \
+                         "endWRENCHUserDoc=\endif" \
+                         "WRENCHDeveloperDoc=\if DEVELOPER" \
+                         "endWRENCHDeveloperDoc=\endif" \
+                         "WRENCHInternalDoc=\if INTERNAL" \
+                         "endWRENCHInternalDoc=\endif"
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding "class=itcl::class"
@@ -791,6 +797,7 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = @CMAKE_HOME_DIRECTORY@/doc/index.md \
+                         @CMAKE_HOME_DIRECTORY@/doc/install.md \
                          @CMAKE_HOME_DIRECTORY@/src \
                          @CMAKE_HOME_DIRECTORY@/include
 
@@ -1447,7 +1454,7 @@ ECLIPSE_DOC_ID         = org.doxygen.Project
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-DISABLE_INDEX          = NO
+DISABLE_INDEX          = YES
 
 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
 # structure should be generated to display hierarchical information. If the tag