README

   1 Welcome to Perltidy!
   2     Perltidy is a tool to indent and reformat perl scripts. It can also
   3     write scripts in html format.
   4
   5     Perltidy is free software released under the GNU General Public License
   6     -- please see the included file "COPYING" for details.
   7
   8 PREREQUISITES
   9     Perltidy is programmed to work with versions of Perl as old as 5.004.
  10     (You can find your version with "perl -v"). However, some systems this
  11     old may have problems, particularly Windows versions.
  12
  13     This this release was successfully tested on a 5.004_04 linux
  14     distribution (1997) and a 5.005_03 Windows version (ActiveState build
  15     522, 1999).
  16
  17     The following modules are not required, but perltidy may use them if
  18     detected:
  19
  20       Win32    will be used to help identify a Windows system if detected
  21       HTML::Entities  will be used to encode HTML entities if detected
  22       Pod::Html will be used to format pod text
  23
  24     The total disk space needed after removing the installation directory
  25     will about 1 Mb.
  26
  27 DOWNLOAD
  28     There are two source distribution files:
  29
  30     *   A .tgz "tarball", with Unix-style <lf> line endings, and
  31
  32     *   A zip file, .zip, with Windows-style <cr><lf> line endings.
  33
  34     In addition, the web site has links to debian and RPM packages.
  35
  36 INSTALLATION
  37     For most standard installations, the standard Makefile.PL method should
  38     work:
  39
  40      perl Makefile.PL
  41      make
  42      make test
  43      make install
  44
  45     The INSTALL file has additional installation notes.
  46
  47 WHAT NEXT
  48     Please see the CHANGES file for notices of any recent updates.
  49
  50     Please see the BUGS file for a list of all known open bugs.
  51
  52     Documentation can be found in the docs directory, and it can also be
  53     found at http://perltidy.sourceforge.net
  54
  55     Reading the brief tutorial should help you use perltidy effectively.
  56
  57     Perltidy is still being developed, so please check sourceforge
  58     occasionally for updates. New releases are announced on freshmeat.net.
  59
  60 FEEDBACK / BUG REPORTS
  61     Bug reports, comments and suggestions are welcome. Attach the smallest
  62     piece of code which demonstrates the bug or issue. Your efforts are
  63     greatly appreciated!
  64
  65     Thank You
  66
  67      Steve Hancock
  68      perltidy at users.sourceforge.net
  69      http://perltidy.sourceforge.net
  70