Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Clean the gtut files.
[simgrid.git] / doc / gtut-files / gtut-main.doc
diff --git a/doc/gtut-files/gtut-main.doc b/doc/gtut-files/gtut-main.doc
new file mode 100644 (file)
index 0000000..c916ece
--- /dev/null
@@ -0,0 +1,50 @@
+/**
+@addtogroup GRAS_tut
+
+This section constitutes a tutorial to the GRAS programming environment.
+
+ - \ref GRAS_tut_intro :\n
+   This section details what GRAS is, and what are the target application
+   class. It also formalize somehow the communication model used in GRAS.\n
+   If you are new to the system and want to start using the tool as quickly
+   as possible and learn by trying things out instead of reading a lenghty
+   manual, you might want to start from next section directly.
+   - \ref GRAS_tut_intro_what
+   - \ref GRAS_tut_intro_model
+
+ - \ref GRAS_tut_tour :\n
+   This section aims at turning new-comers into GRAS power user. It briefly
+   explains how to install the framework and setup your own projects. Then,
+   an example distributed application is builded incrementaly to show the
+   several aspects of the framework.
+   - Part 1: Bases
+     - \ref GRAS_tut_tour_install
+     - \ref GRAS_tut_tour_setup
+   - Part 2: Message passing
+     - \ref GRAS_tut_tour_simpleexchange
+     - \ref GRAS_tut_tour_args
+     - \ref GRAS_tut_tour_callbacks
+     - \ref GRAS_tut_tour_globals
+     - \ref GRAS_tut_tour_logs
+     - \ref GRAS_tut_tour_timers
+     - \ref GRAS_tut_tour_exceptions
+     - \ref GRAS_tut_tour_simpledata
+     - \ref GRAS_tut_tour_rpc
+     - \ref GRAS_tut_tour_explicitwait
+     - \ref GRAS_tut_tour_message_recaping
+   - Part 3: Data description
+     - \ref GRAS_tut_tour_staticstruct
+     - \ref GRAS_tut_tour_pointers
+     - \ref GRAS_tut_tour_dynar
+     - \ref GRAS_tut_tour_manualdatadef
+     - \ref GRAS_tut_tour_exchangecb
+   - Part 4: Advanced topics (TODO)
+
+ - \ref GRAS_howto :\n
+   This section contains some self-contained document explaining one
+   aspect of the framework which would be hard to integrate in the
+   suite of lessons composing the tutorial.
+    - \ref GRAS_howto_design
+
+*/
+