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