diff --git a/README b/README index 4cdb2c0..bed0a5f 100644 --- a/README +++ b/README @@ -1,28 +1,49 @@ -Tree/Simple version 1.18 -======================== +README file for Tree::Simple. -See the module documentation for more information. +See also: CHANGES and Changelog.ini. -INSTALLATION +Warning: WinZip 8.1 and 9.0 both contain an 'accidental' bug which stops +them recognizing POSIX-style directory structures in valid tar files. +You are better off using a reliable tool such as InfoZip: +ftp://ftp.info-zip.org/pub/infozip/ -To install this module type the following: +1 Installing from a Unix-like distro +------------------------------------ +shell>gunzip Tree-Simple-1.23.tgz +shell>tar mxvf Tree-Simple-1.23.tar - perl Makefile.PL - make - make test - make install +On Unix-like systems, assuming you have installed Module::Build V 0.25+: -DEPENDENCIES +shell>perl Build.PL +shell>./Build +shell>./Build test +shell>./Build install -This module requires no other modules and libraries outside of the core -for normal usage. However it uses Test::Exception in the test suite. +On MS Windows-like systems, assuming you have installed Module::Build V 0.25+: -COPYRIGHT AND LICENCE +shell>perl Build.PL +shell>perl Build +shell>perl Build test +shell>perl Build install -Copyright (C) 2004-2006 Infinity Interactive, Inc. +Alternately, without Module::Build, you do this: -http://www.iinteractive.com +Note: 'make' on MS Windows-like systems may be called 'nmake' or 'dmake'. -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +shell>perl Makefile.PL +shell>make +shell>make test +shell>su (for Unix-like systems) +shell>make install +shell>exit (for Unix-like systems) +On all systems: + +Run Simple.pm through your favourite pod2html translator. + +2 Installing from an ActiveState distro +--------------------------------------- +shell>unzip Tree-Simple-1.23.zip +shell>ppm install --location=. Tree-Simple +shell>del Tree-Simple-1.23.ppd +shell>del PPM-Tree-Simple-1.23.tar.gz