import Devel-Size 0.69 from CPAN

[p5sagit/Devel-Size.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..9f99cf1
--- /dev/null
+++ b/README
@@ -0,0 +1,61 @@
+=pod
+
+Devel::Size - Perl extension for finding the memory usage of Perl variables
+
+=head1 SYNOPSIS
+
+  use Devel::Size qw(size total_size);
+
+  my $size = size("A string");
+
+  my @foo = (1, 2, 3, 4, 5);
+  my $other_size = size(\@foo);
+
+  my $foo = {a => [1, 2, 3],
+         b => {a => [1, 3, 4]}
+         };
+  my $total_size = total_size($foo);
+
+=head1 DESCRIPTION
+
+This module figures out the real size of Perl variables in bytes, as
+accurately as possible.
+
+=head1 Build and Install
+
+To build and install this module, you need:
+
+        Perl
+        a working C or C++ compiler
+        a make (or namke on Windows) utility
+
+Follow these steps:
+
+On Linux, Cygwin, or Unix:
+
+       perl Makefile.PL
+       make
+       make test
+       sudo make install
+
+On Windows:
+
+       perl Makefile.PL
+       nmake
+       nmake test
+       nmake install
+
+=head1 BUGREPORTS
+
+Please report bugs to:
+
+       http://rt.cpan.org/NoAuth/Bugs.html?Dist=Devel-Size
+
+=head1 COPYRIGHT
+
+Copyright (C) 2005 Dan Sugalski, Copyright (C) 2007 Tels
+
+This module is free software; you can redistribute it and/or modify it
+under the same terms as Perl v5.8.8.
+
+=cut