docs/parrot.pod

   1 # Copyright (C) 2001-2005, Parrot Foundation.
   2 # $Id$
   3
   4 =head1 NAME
   5
   6 docs/parrot.pod - Parrot
   7
   8 =head1 The Parrot Virtual Machine
   9
  10 Parrot is a language-agnostic common bytecode format and an interpreter for
  11 dynamic languages.
  12
  13 =head2 Documentation
  14
  15 The Parrot documentation is spread across a wide range of files.  Good starting
  16 points are:
  17
  18 =over 4
  19
  20 =item F<intro.pod>
  21
  22 An introductory article on what Parrot is and how to do some interesting things
  23 with it.
  24
  25 =item F<overview.pod>
  26
  27 An overview of the Parrot architecture and design.
  28
  29 =item F<running.pod>
  30
  31 Brief descriptions of the different executables and how to run them.
  32
  33 =item F<faq.pod>
  34
  35 The Parrot FAQ.
  36
  37 =item F<glossary.pod>
  38
  39 A guide to some of the jargon that crops up repeatedly in Parrot development
  40 (and in the documentation...)
  41
  42 =back
  43
  44 More detailed information on the design and implementation of Parrot can be
  45 found in:
  46
  47 =over 4
  48
  49 =item F<pdds/>
  50
  51 This subdirectory contains all of the current Parrot Design Documents (PDDs).
  52 These are intended to be detailed guides to the design of the various Parrot
  53 subsystems; for instance, F<pdd03_calling_conventions.pod> specifies Parrot's
  54 inter-routine calling conventions.
  55
  56 =item F<ops/>
  57
  58 This subdirectory contains documentation files that are created from the
  59 corresponding opcode files at build time. These files describe what each opcode
  60 does and specify what arguments they take.
  61
  62 =item F<pmc/>
  63
  64 This subdirectory contains documentation on several of the PMC types available
  65 to Parrot. Currently only a few of the available PMCs have been documented.
  66 (Patches welcome!)
  67
  68 =item F<dev/>
  69
  70 This subdirectory contains a number of files discussing various implementation
  71 decisions made during the course of the development of Parrot. The intent is to
  72 keep discussion of implementation-specific issues separate from the basic
  73 design issues discussed in the PDDs.
  74
  75 =item F<vtables.pod>
  76
  77 A brief introduction to the vtable at the heart of all PMCs, and how to
  78 implement your own PMC type.
  79
  80 =item F<embed.pod>
  81
  82 Describes the embedding subsystem in excruciating detail.
  83
  84 =item F<memory_internals.pod>
  85
  86 An introduction to the Parrot GC subsystem
  87
  88 =item F<parrotbyte.pod>
  89
  90 The Parrot bytecode format.
  91
  92 =item F<packfile-perl.pod>, F<packfile-c.pod>
  93
  94 The APIs for accessing packed bytecode files (packfiles) from Perl and C.
  95
  96 =item F<strings.pod>
  97
  98 A description of the string implementation.
  99
 100 =item F<tests.pod>
 101
 102 Hints on writing tests for the Parrot interpreter.
 103
 104 =item F<debug.pod>
 105
 106 A beginner's guide to debugging the Parrot executable.
 107
 108 =item F<debugger.pod>
 109
 110 Documentation for C<parrot_debugger>, the Parrot debugger.
 111
 112 =back
 113
 114 =head2 Supported Platforms
 115
 116 Parrot compiles and runs on a large number of platforms, including all common
 117 ones. The Parrot team is committed to supporting the following combinations as
 118 "core platforms": Linux (x86), Win32 (x86), OS X (x86 and PPC), Cygwin, Tru64,
 119 OpenVMS (Alpha), FreeBSD (x86).
 120
 121 =head2 Authors
 122
 123 Parrot is developed and maintained by the members of the
 124 C<parrot-dev@lists.parrot.org> mailing list. The list is archived at:
 125 L<http://groups.google.com/group/parrot-dev/>
 126 Many people have contributed their time and expertise
 127 to the Parrot project; see the F<CREDITS> file for details.
 128
 129 =head2 Web pages
 130
 131 See:
 132
 133 =over 4
 134
 135 =item * L<http://www.parrot.org/>
 136
 137 =item * L<https://trac.parrot.org/>
 138
 139 =item * L<https://svn.parrot.org/>
 140
 141 =back
 142
 143 for more information.
 144