Filled-in with minimal content the 'README.pod' file.

parrot · May 8, 2012 · 705eff5 · 705eff5
1 parent 3b24360
commit 705eff5
Showing 1 changed file with 6 additions and 32 deletions.
diff --git a/docs/binaries/README.pod b/docs/binaries/README.pod
@@ -8,40 +8,14 @@ docs/binaries/README.pod - Readme file for the 'docs/binaries/' directory.
 
 =head1 DESCRIPTION
 
-This README sets out [...]. 
+This directory contains the *.pod files to the installable binaries in the
+Parrot distribution. These files are also (or soon will be) used to generate
+*roff pages.[1]
 
-I really want to rename 'parrot.pod' to 'README.pod' and add some additional
-information to the file.
+=head1 NOTES
 
-=head2 [...] 
-
-=over 4
-
-=item * [...].
-
-=item * [...].
-
-=over 8
-
-=item * [...].
-
-=item * [...].
-
-=back
-
-=item * [...].
-
-=item * [...].
-
-=item * [...].
-
-=item * [...].
-
-=back
-
-=head2 [...]
-
-[...]
+[1] The probable location and name of the conversion script will be,
+F<tools/docs/mk_pod2man.pl>
 
 =head1 COPYRIGHT