New upstream version 20190601

[perltidy.git] / docs / index.html

diff --git a/docs/index.html b/docs/index.html
new file mode 100644 (file)
index 0000000..fb38259
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,72 @@
+<h1>Welcome to Perltidy</h1>
+
+<p>Perltidy is a Perl script which indents and reformats Perl scripts to make them
+easier to read.  If you write Perl scripts, or spend much time
+reading them, you will probably find it useful.</p>
+
+<p>Perltidy is free software released under the GNU General Public
+License -- please see the included file <a href="../COPYING">COPYING</a> for details.</p>
+
+<p>The formatting can be controlled with command line parameters.  The default
+parameter settings approximately follow the suggestions in the
+<a href="https://perldoc.perl.org/perlstyle.html">Perl Style Guide</a>.</p>
+
+<p>Besides reformatting scripts, Perltidy can help in tracking
+down errors with missing or extra braces, parentheses, and square brackets
+because it is very good at localizing errors.</p>
+
+<h2>Documentation</h2>
+
+<ul>
+<li><p><a href="./tutorial.html">A Brief Perltidy Tutorial</a></p></li>
+<li><p><a href="./stylekey.html">Perltidy Style Key</a> will help
+in methodically selecting a set of style parameters.</p></li>
+<li><p><a href="./perltidy.html">The Perltidy man page</a> explains how
+to precisely control the formatting details.</p></li>
+<li><p><a href="./Tidy.html">The Perl::Tidy man page</a> discusses how to use the Perl::Tidy module</p></li>
+<li><p><a href="./ChangeLog.html">Change Log</a></p></li>
+</ul>
+
+<h2>Prerequisites</h2>
+
+<p>Perltidy should run on any system with perl 5.008 or later.
+The total disk space needed after removing the installation directory will be
+about 2 Mb.</p>
+
+<h2>Download</h2>
+
+<ul>
+<li><p>The most recent release is always at <a href="https://metacpan.org/release/Perl-Tidy">CPAN</a></p></li>
+<li><p>The most recent release is also at <a href="https://sourceforge.net/projects/perltidy/">sourceforge</a></p></li>
+</ul>
+
+<h2>Installation</h2>
+
+<p>Perl::Tidy can be installed directly from CPAN one of the standard methods.</p>
+
+<p>One way is to download a distribution file, unpack it and then 
+test and install using the Makefile.PL:</p>
+
+<pre><code>perl Makefile.PL
+make
+make test
+make install
+</code></pre>
+
+<p>The <a href="./INSTALL.html">INSTALL file</a> has additional installation notes. They
+are mainly for older sytems but also tell how to use perltidy without doing an installation.</p>
+
+<h2>Links</h2>
+
+<ul>
+<li><a href="https://github.com/perltidy/perltidy">Perl::Tidy source code repository at GitHub</a></li>
+<li><a href="https://metacpan.org/pod/distribution/Code-TidyAll/bin/tidyall">tidyall</a> is a great tool for automatically running perltidy and other tools including perlcritic on a set of project files.</li>
+<li><a href="http://sourceforge.net/projects/tidyview">Tidyview</a> is a graphical program for tweaking your .perltidyrc configuration parameters.</li>
+<li><a href="https://github.com/vifo/SublimePerlTidy">A perltidy plugin for Sublime Text 2/3</a></li>
+</ul>
+
+<h2>FEEDBACK / BUG REPORTS</h2>
+
+<p>A list of current bugs and issues can be found at the CPAN site <a href="https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy">https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy</a></p>
+
+<p>To report a new bug or problem, use the link on this page .</p>