examples/README

   1 Peter Keller is the author and current maintainer of the IOLib tutorial and
   2 associated examples.
   3
   4 The file named "tutorial" is generated by a perl script called "gen-tutorial"
   5 and an input file called "tutorial.tmpl". If the tutorial is not present, or
   6 you are hacking on it to contribute back to it, then generate the tutorial by
   7 typing 'make' at the command line while in the examples/ directory. The code
   8 examples in the generated tutorial are picked out the the actual source codes
   9 for the examples by the gen-tutorial program which allows much easier
  10 management of the tutorial. The source code markers for the example code
  11 sections used by the gen-tutorial program are detailed in the tutorial. The
  12 method of inclusion of the examples is obvious and shown in the tutorial.tmpl
  13 file.
  14
  15 Any submitted patches to the tutorial itself should be against the
  16 tutorial.tmpl file and sent to the iolib development list. All tabs are to be
  17 converted to 4 spaces. Patches against the tutorial source codes should also be
  18 sent to the iolib development list.
  19
  20 Thank you.
  21
  22 Peter Keller
  23 (psilord.cs.wisc.edu)