Anonymous committed c6387fb

Got the tests to pass with the boilerplate.

  • Participants
  • Parent commits a5b126b

Comments (0)

Files changed (5)


 Revision history for File-Dir-Dumper
-0.01    Date/time
-        First version, released on an unsuspecting world.
+0.0.1   TODO : FILL IN
+        First version
+            - doesn't handle symbolic links.




-The README is used to introduce the module and provide instructions on
-how to install the module, any machine dependencies it may have (for
-example C compilers and installed libraries) and any other information
-that should be provided before the module is installed.
-A README file is required for CPAN modules since CPAN extracts the README
-file from a module distribution so that people browsing the archive
-can use it to get an idea of the module's uses. It is usually a good idea
-to provide version information here so that people can decide whether
-fixes for the module are worth downloading.
+File-Dir-Dumper aims to dump directory structures in a consisten, machine 
+parseable and moderately-human-readble way. It makes use of File-Find-Object,
+and the JSON format.
 Copyright (C) 2008 Shlomi Fish
-This program is released under the following license: mit
+This program is released under the following license: MIT/X11 License:


 =head1 NAME
-File::Dir::Dumper - The great new File::Dir::Dumper!
+File::Dir::Dumper - dump directory structures' meta-data in a consistent and 
+machine-readable way.
 =head1 VERSION
-Version 0.01
+Version 0.0.1
-our $VERSION = '0.01';
+our $VERSION = '0.0.1';
 =head1 SYNOPSIS
-Quick summary of what the module does.
-Perhaps a little code snippet.
     use File::Dir::Dumper;
-    my $foo = File::Dir::Dumper->new();
-    ...
+    my $dumper = File::Dir::Dumper->new(
+        {
+            output_to => \*STDOUT,
+            source => "/path/to/dir/to/dump",
+        }
+    );
-=head1 EXPORT
-A list of functions that can be exported.  You can delete this section
-if you don't export anything, such as for a purely object-oriented module.
-=head2 function1
-sub function1 {
-=head2 function2
-sub function2 {
+=head1 METHODS
 =head1 AUTHOR
-Shlomi Fish, C<< <shlomif at> >>
+Shlomi Fish, C<< <> >>
 =head1 BUGS
 Copyright 2008 Shlomi Fish, all rights reserved.
-This program is released under the following license: mit
+This program is released under the following license: MIT/X11 Licence.


-TODO: {
-  local $TODO = "Need to replace the boilerplate text";
   not_in_file_ok(README =>
     "The README is used..."       => qr/The README is used/,
     "'version information here'"  => qr/to provide version information/,