Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
start refunding the userguide
[simgrid.git] / doc / doxygen / internals.doc
similarity index 54%
rename from doc/user_guide/doxygen/index.doc
rename to doc/doxygen/internals.doc
index 33d26a6..fbd9087 100644 (file)
@@ -1,45 +1,7 @@
-/*!  
-@mainpage SimGrid User Guide
-<center>
-\htmlonly
-<table width="100%">
-       <tr>
-               <td valign="middle" align="left">
-                               <img src="simgrid_logo_2011.png" alt="SimGrid - Scalable simulation of distributed systems, ranging from grids to peer-to-peer systems" />
-               </td>
-               <td valign="middle" align="left">
-\endhtmlonly
-\htmlonly
-               </td>
-       </tr>
-</table>
-\endhtmlonly
-</center>
-
-Welcome to the SimGrid user guide. In this document, you will find how to install, get started, configure, and run your first simulation with SimGrid.
+/*! @page internals SimGrid internals
 
-\section sim_over SimGrid Overview
-SimGrid is a toolkit that provides core functionalities for the simulation
-of distributed applications in heterogeneous distributed environments.
-
-The specific goal of the project is to facilitate research in the area of
-distributed and parallel application scheduling on distributed computing
-platforms ranging from simple network of workstations to Computational
-Grids.
-
-  - The official webpage is <a href="http://simgrid.gforge.inria.fr/">simgrid.gforge.inria.fr</a>.
-  - The Frequently Asked Questions for the latest version are <a href="http://simgrid.gforge.inria.fr/simgrid/latest/doc/FAQ.html">here</a>.
-  - The development webpage is <a href="https://gforge.inria.fr/projects/simgrid//">gforge.inria.fr/projects/simgrid</a>.
-  - The user mailing list is <simgrid-user@lists.gforge.inria.fr>
-  - The SimGrid software package can be downloaded from <a href="http://simgrid.gforge.inria.fr/download.html">here</a>.
-<br>
-
-<hr>
-
-\section ug_overview Overview of the toolkit components
-
-As depicted by the following diagram, the SimGrid toolkit is basically
-three-layered (click on the picture to jump to a specific component).
+This page does not exist yet, sorry. We are currently refurbishing the
+user documentation -- the internal documentation will follow (FIXME).
 
 
 \htmlonly
@@ -47,11 +9,14 @@ three-layered (click on the picture to jump to a specific component).
 \endhtmlonly
 \htmlinclude simgrid_modules.map
 \htmlonly
-<br><b>Relationships between the SimGrid components (click to jump to API)</b>
+<br><b>SimGrid Components (click to jump to API)</b>
 </center>
 \endhtmlonly
 
 
+\section ug_overview Overview of the toolkit components
+
+
 \subsection ug_overview_envs Programmation environments layer
 
 SimGrid provides several programmation environments built on top of a unique
@@ -108,25 +73,4 @@ See the \ref XBT_API section for more details.
 \subsection ug_lucas_layer Tracing simulation
 Finally, a transversal module allows you to trace your simulation. More documentation in the section \ref TRACE_doc
 
-
-<br>
-The SimGrid software package can be downloaded from
-<a href="http://simgrid.gforge.inria.fr/download.html">here</a>.<br>
-
-If you are interested in the history of SimGrid and in current and planned development,
-you can find out more <a href="http://simgrid.gforge.inria.fr/history.html">here</a>.
-
-Any question, remark or suggestion are welcome on the
-<a href="http://lists.gforge.inria.fr/mailman/listinfo/simgrid-user">SimGrid users
-mailing list</a>.
-
-
-<hr>
-\htmlonly
-<center>
-<a href="http://creativecommons.org/licenses/LGPL/2.1/"><img alt="CC-GNU LGPL" border="0" src="http://creativecommons.org/images/public/cc-LGPL-a.png" /></a>
-</center>
-\endhtmlonly
-
-
-*/
+*/
\ No newline at end of file