Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid
[simgrid.git] / doc / doxygen / internals.doc
index fbd9087..e3ecacd 100644 (file)
@@ -1,8 +1,29 @@
-/*! @page internals SimGrid internals
+/*! @page internals SimGrid Developer Guide
 
 This page does not exist yet, sorry. We are currently refurbishing the
 user documentation -- the internal documentation will follow (FIXME).
 
+All we can say for now is that once you learn a bit about the SimGrid
+internals, you will probably look a bit like this:
+
+@image html DiscoveringSimgrid.gif Discovering SimGrid's Internals.
+
+There is two main things you want to know about the internals of
+SimGrid. First, you need to understand the component organization, as
+SimGrid is heavily layered, with each level being rather highly
+specialized and optimized toward a task. For that, please keep reading
+this page. If you work actively on the SimGrid project, the second
+point you need to understand is about the infrastructure of the
+SimGrid project, ie how to extend the framework in any way, how the
+automatic tests are run, and so on. These informations are split on
+several pages, as follows:
+
+ - @subpage inside_doxygen
+ - @subpage inside_extending
+ - @subpage inside_cmake
+ - @subpage inside_release
+ - @subpage inside_ci
+
 
 \htmlonly
 <center>
@@ -73,4 +94,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
 
-*/
\ No newline at end of file
+*/