Permalink
Browse files

Updated to provide more info about what's in 'tools/'.

  • Loading branch information...
1 parent a741836 commit 0c03d1f7697551d9566271e477b81cf39596178f @ayardley ayardley committed May 13, 2012
Showing with 33 additions and 3 deletions.
  1. +33 −3 tools/README.pod
View
@@ -8,9 +8,39 @@ tools/README.pod - Readme file for the 'tools/' top-level directory.
=head1 DESCRIPTION
-This directory contains utility programs used by the Parrot developers,
-I<e.g.,> makefile generation, release automation, smolder report submission,
-and file creation for new languages.
+This directory contains multiple subdirectories which are outlined as follows:
+
+=over 4
+
+=item F<build/>
+
+This subdirectory contains programs, templates, and configuration files
+invoked by the default 'make' target I<e.g.,> 'make all', with or without
+command-line options, during the Parrot build process.
+
+=item F<dev/>
+
+This subdirectory contains programs, templates, and configuration files found
+useful to Parrot developers, excluding those which are (1) invoked via the
+default 'make' target I<e.g.,> 'make all' or (2) invoked by 'make install' or
+'make install-dev'.
+
+=item F<docs/>
+
+This subdirectory contains programs, templates, and configuration files found
+useful for working with or for the building of Parrot's documentation.
+
+=item F<install/>
+
+This subdirectory contains programs, templates, and configuration files
+found useful for the post-installation of Parrot, I<e.g.,> smoke reports.
+
+=item F<release/>
+
+This subdirectory contains programs, templates, and configuration files
+invoked by 'make install' or 'make install-dev'.
+
+=back
=head1 COPYRIGHT

0 comments on commit 0c03d1f

Please sign in to comment.