Skip to content
This repository
Browse code

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

  • Loading branch information...
commit 0c03d1f7697551d9566271e477b81cf39596178f 1 parent a741836
Alvis Yardley ayardley authored

Showing 1 changed file with 33 additions and 3 deletions. Show diff stats Hide diff stats

  1. +33 3 tools/README.pod
36 tools/README.pod
Source Rendered
@@ -8,9 +8,39 @@ tools/README.pod - Readme file for the 'tools/' top-level directory.
8 8
9 9 =head1 DESCRIPTION
10 10
11   -This directory contains utility programs used by the Parrot developers,
12   -I<e.g.,> makefile generation, release automation, smolder report submission,
13   -and file creation for new languages.
  11 +This directory contains multiple subdirectories which are outlined as follows:
  12 +
  13 +=over 4
  14 +
  15 +=item F<build/>
  16 +
  17 +This subdirectory contains programs, templates, and configuration files
  18 +invoked by the default 'make' target I<e.g.,> 'make all', with or without
  19 +command-line options, during the Parrot build process.
  20 +
  21 +=item F<dev/>
  22 +
  23 +This subdirectory contains programs, templates, and configuration files found
  24 +useful to Parrot developers, excluding those which are (1) invoked via the
  25 +default 'make' target I<e.g.,> 'make all' or (2) invoked by 'make install' or
  26 +'make install-dev'.
  27 +
  28 +=item F<docs/>
  29 +
  30 +This subdirectory contains programs, templates, and configuration files found
  31 +useful for working with or for the building of Parrot's documentation.
  32 +
  33 +=item F<install/>
  34 +
  35 +This subdirectory contains programs, templates, and configuration files
  36 +found useful for the post-installation of Parrot, I<e.g.,> smoke reports.
  37 +
  38 +=item F<release/>
  39 +
  40 +This subdirectory contains programs, templates, and configuration files
  41 +invoked by 'make install' or 'make install-dev'.
  42 +
  43 +=back
14 44
15 45 =head1 COPYRIGHT
16 46

0 comments on commit 0c03d1f

Please sign in to comment.
Something went wrong with that request. Please try again.