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