diff --git a/compilers/README.pod b/compilers/README similarity index 67% rename from compilers/README.pod rename to compilers/README index a884dd9747..fdde5177a2 100644 --- a/compilers/README.pod +++ b/compilers/README @@ -1,51 +1,47 @@ -=head1 NAME +== NAME == - compilers/ - various compilers used by Parrot +compilers - various compilers used by Parrot -=head1 DESCRIPTION +== DESCRIPTION == -The F directory contains the source files for several compilers that +The 'compilers' directory contains the source files for several compilers that are used by Parrot such as IMCC and PGE. For more detailed information on -these, please see their respective F files in the subdirectories -listed below. +these, please see their respective README files in the subdirectories listed +below. -=head1 SUBDIRECTORIES +== SUBDIRECTORIES == -=over 4 - -=item F +* data_json Source files for the JavaScript Object Notation (JSON) compiler. Used when generating a JSON representation of a PMC. -=item F +* imcc Source files for the Intermediate Code Compiler (IMCC). Translates PIR files into Parrot bytecode. -=item F +* opsc Source files for the opcode compiler (a.k.a. ops2c). Converts opcode definition files into C code. -=item F +* pct Source files for the compiler used by the Parrot Compiler Toolkit (PCT). -=item F +* pge Source files for the compiler used by the Parrot Grammar Engine (PGE). This is an implementation of Perl 6 regexes. -=item F +* tge Source files for the compiler used by the Tree Grammer Engine (TGE). This is the tool used to transform the trees output by the PGE into a Parrot Abstract Syntax Tree (PAST). -=back - -=head1 COPYRIGHT +== COPYRIGHT == Copyright (C) 2001-2011, Parrot Foundation. diff --git a/examples/README.pod b/examples/README similarity index 65% rename from examples/README.pod rename to examples/README index b8e44f0a36..f9e882179e 100644 --- a/examples/README.pod +++ b/examples/README @@ -1,127 +1,123 @@ -=head1 NAME +== NAME == - examples/ - helpful examples of common tasks with Parrot +examples - helpful examples of common tasks with Parrot -=head1 DESCRIPTION +== DESCRIPTION == -The F directory provides examples of some of the more common - and +The 'examples' directory provides examples of some of the more common - and sometimes hillarious - uses of the Parrot virtual machine. If you are new to the world of Parrot, browsing through some of these examples can be incredibly -helpful. Most of these examples are tested by the test files in F. +helpful. Most of these examples are tested by the test files in 't/examples'. -=head1 SUBDIRECTORIES +== SUBDIRECTORIES == -=over 4 +* benchmarks -=item F - -Benchmark test examples. They can be run with C. +Benchmark test examples. They can be run with `make benchmark_tests`. -=item F +* c Examples in C that demonstrate the embedding API and how the Parrot frontend interprets bytecode. -=item F +* compilers -Example of a compiler called C. +Example of a compiler called JAPH. -=item F +* config -An example demonstrating how F works. +An example demonstrating how Configure.pl works. -=item F +* embed An example of how the embedding API can be used. -=item F +* io Examples of Parrot's IO subsystem in PIR. -=item F +* json Examples demonstrating how to generate a JSON representation of a PMC. -=item F +* languages -Contains the source files for the demo languages C and C. +Contains the source files for the demo languages abc and Squaak. Demonstrates how to use the Parrot Compiler Toolkit (PCT). -=item F +* library Examples demonstrating how to use Parrot's runtime libraries in PIR. -=item F +* mops -Contains an example called I in various languages which +Contains an example called "million ops per second" in various languages which calculates a value for M ops/s using integer arithmetic. -=item F +* namespace Examples demonstrating how to use namespaces in PIR. -=item F +* nci Examples demonstrating Parrot's Native Call Interface (NCI). -=item F +* opengl Examples demonstrating how to use the OpenGL library in PIR and Perl 6. -=item F +* pasm Examples of common tasks in Parrot Assembly Language (PASM). -=item F +* past Examples of a PAST to PIR translation. -=item F +* pge Contains an example PIR generated file using the Parrot Grammar Engine (PGE). -=item F +* pir Examples of common tasks in Parrot Intermediate Representation (PIR). -=item F +* sdl Examples demonstrating how to use the Simple DirectMedia Layer (SDL) library in PIR. -=item F +* shootout Contains the PIR files used for The Computer Language Benchmark Game or The Great Computer Languages Shootout. -=item F +* streams Examples demonstrating how to use the Stream library. -=item F +* subs Examples demonstrating how to call subroutines in PIR and PASM. -=item F +* tcl Examples demonstrating how to create a Tcl/Tk GUI using the NCI. -=item F +* tge Examples demonstrating the Tree Grammer Engine (TGE). -=item F +* tools Examples of miscellaneous tools such as a bytecode checker and a grep-like utility. -=item F +* tutorial A PIR tutorial by example. -=back - -=head1 COPYRIGHT +== COPYRIGHT == Copyright (C) 2001-2011, Parrot Foundation.