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