examples/tutorial/00_README.pod

   1 =head1 PIR tutorial
   2
   3 Each of the files in this directory contains valid PIR code and POD
   4 (Perl 5's Plain Old Documentation) and can be read as plain text.
   5 To view just the documentation without the sample code, use C<perldoc>:
   6
   7  perldoc example.pir
   8
   9 If you'd like to execute the code from files you need to build parrot and
  10 then type:
  11
  12  ../../parrot example.pir
  13
  14 The parrot test suite also checks the output of these examples, so you
  15 always know that they are valid PIR code. You can execute all the tests
  16 by typing:
  17
  18  cd ../../ ; prove -v t/examples/tutorial.t ; cd examples/tutorial
  19
  20 When adding an new example or changing the output of an example please
  21 update F<t/examples/tutorial.t> as well.
  22
  23 =cut
  24
  25 # Local Variables:
  26 #   mode: pir
  27 #   fill-column: 100
  28 # End:
  29 # vim: expandtab shiftwidth=4 ft=pir:
  30