doc/gtut-tour.doc

   1
   2 /**
   3 @page GRAS_tut_tour GRAS initiatic tour
   4
   5 During this tour, you will learn all you need to write your own GRAS
   6 applications, from the installation of the framework to the use of (almost)
   7 all features available in GRAS.
   8
   9     \htmlonly <!--
  10       DOXYGEN_NAVBAR_CHILD "0: Installing"=GRAS_tut_tour_install.html
  11       DOXYGEN_NAVBAR_CHILD "1: Setup a project"=GRAS_tut_tour_setup.html
  12       DOXYGEN_NAVBAR_CHILD "2: Simple messaging"=GRAS_tut_tour_simpleexchange.html
  13       DOXYGEN_NAVBAR_CHILD "3: Process args"=GRAS_tut_tour_args.html
  14       DOXYGEN_NAVBAR_CHILD "4: Callbacks"=GRAS_tut_tour_callbacks.html
  15       DOXYGEN_NAVBAR_CHILD "5: Globals"=GRAS_tut_tour_globals.html
  16       DOXYGEN_NAVBAR_CHILD "6: Logs"=GRAS_tut_tour_logs.html
  17       DOXYGEN_NAVBAR_CHILD "7: Timers"=GRAS_tut_tour_timers.html
  18       DOXYGEN_NAVBAR_CHILD "8: Exceptions"=GRAS_tut_tour_exceptions.html
  19       DOXYGEN_NAVBAR_CHILD "9: RPC"=GRAS_tut_tour_rpc.html
  20     --> \endhtmlonly
  21
  22  - \ref GRAS_tut_tour_setup
  23     - \ref GRAS_tut_tour_setup_C
  24     - \ref GRAS_tut_tour_setup_plat
  25     - \ref GRAS_tut_tour_setup_deploy
  26     - \ref GRAS_tut_tour_setup_glue
  27     - \ref GRAS_tut_tour_setup_make
  28     - \ref GRAS_tut_tour_setup_start
  29
  30  - \ref GRAS_tut_tour_simpleexchange
  31     - \ref GRAS_tut_tour_simpleexchange_msgtype
  32     - \ref GRAS_tut_tour_simpleexchange_socks
  33     - \ref GRAS_tut_tour_simpleexchange_exchange
  34     - \ref GRAS_tut_tour_simpleexchange_recaping
  35
  36  - \ref GRAS_tut_tour_args
  37     - \ref GRAS_tut_tour_args_use
  38     - \ref GRAS_tut_tour_args_sg
  39     - \ref GRAS_tut_tour_args_recap
  40
  41  - \ref GRAS_tut_tour_callbacks
  42     - \ref GRAS_tut_tour_callbacks_declare
  43     - \ref GRAS_tut_tour_callbacks_attach
  44     - \ref GRAS_tut_tour_callbacks_handle
  45     - \ref GRAS_tut_tour_callback_recap
  46
  47  - \ref GRAS_tut_tour_globals
  48     - \ref GRAS_tut_tour_globals_intro
  49     - \ref GRAS_tut_tour_globals_use
  50     - \ref GRAS_tut_tour_callback_pitfall
  51     - \ref GRAS_tut_tour_callback_recap
  52
  53  - \ref GRAS_tut_tour_logs
  54     - \ref GRAS_tut_tour_logs_intro
  55     - \ref GRAS_tut_tour_logs_practice
  56     - \ref GRAS_tut_tour_logs_recap
  57     - \ref GRAS_tut_tour_logs_config
  58
  59  - \ref GRAS_tut_tour_timers
  60     - \ref GRAS_tut_tour_timers_intro
  61     - \ref GRAS_tut_tour_timers_use
  62     - \ref GRAS_tut_tour_timers_recap
  63
  64  - \ref GRAS_tut_tour_exceptions
  65     - \ref GRAS_tut_tour_exceptions_intro
  66     - \ref GRAS_tut_tour_exceptions_use
  67     - \ref GRAS_tut_tour_exceptions_recap
  68
  69  - \ref GRAS_tut_tour_rpc
  70     - \ref GRAS_tut_tour_rpc_intro
  71     - \ref GRAS_tut_tour_rpc_use
  72     - \ref GRAS_tut_tour_rpc_recap
  73
  74 <hr>
  75
  76
  77 \section GRAS_tut_tour_todo TODO
  78
  79 Unfortunately, the tour is not terminated yet, and here are some ideas of
  80 missing missi^W lessons:
  81
  82 - Lesson 10: Exchanging simple data through ping-pong
  83 - Lesson 11: More complex data description (automatic parsing, manual
  84    description) and example. May need more than one lesson.
  85
  86 - Lesson 12: Splitting in several files
  87
  88 - Lesson 13: Debuging GRAS programs
  89
  90 - Lesson 14: Doing proper modules
  91
  92 */
  93
  94 /**
  95 @page GRAS_tut_tour_install Lesson 0: Installing GRAS
  96
  97 Since GRAS is technically part of the SimGrid project, you have to install
  98 SimGrid to install GRAS. Doing so is explained in the relevant FAQ section
  99 (\ref faq_installation).
 100
 101 Newcommers should install the stable release from the tarball, since the cvs
 102 snapshots may suffer from (additionnal;) stability issues. Only go for the
 103 CVS if you really need features not present in the stable releases yet (or
 104 if you plan to help us improving the tool, what is always welcomed).
 105
 106 */