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     The following modules are not required, but perltidy may use them if
  14     detected:
  15
  16       HTML::Entities  will be used to encode HTML entities if detected
  17       Pod::Html will be used to format pod text
  18
  19     The total disk space needed after removing the installation directory
  20     will about 2 Mb.
  21
  22 DOWNLOAD
  23     There are two source distribution files:
  24
  25     *   A .tgz "tarball", with Unix-style <lf> line endings, and
  26
  27     *   A zip file, .zip, with Windows-style <cr><lf> line endings.
  28
  29     In addition, the web site has links to debian and RPM packages.
  30
  31 INSTALLATION
  32     For most standard installations, the standard Makefile.PL method should
  33     work:
  34
  35      perl Makefile.PL
  36      make
  37      make test
  38      make install
  39
  40     The INSTALL file has additional installation notes, and tells how to use
  41     perltidy without doing an installation.
  42
  43 WHAT NEXT
  44     Please see the CHANGES file for notices of any recent updates.
  45
  46     Please see the BUGS file for a list of all known open bugs.
  47
  48     Documentation can be found in the docs directory, and it can also be
  49     found at http://perltidy.sourceforge.net
  50
  51     Reading the brief tutorial should help you use perltidy effectively.
  52
  53     Perltidy is still being developed, so please check sourceforge
  54     occasionally for updates. New releases are announced on freshmeat.net.
  55
  56 FEEDBACK / BUG REPORTS
  57     Bug reports, comments and suggestions are welcome. Attach the smallest
  58     piece of code which demonstrates the bug or issue. Your efforts are
  59     greatly appreciated!
  60
  61     Thank You
  62
  63      Steve Hancock
  64      perltidy at users.sourceforge.net
  65      http://perltidy.sourceforge.net
  66