Skip to content

Commit

Permalink
Final updates to README, etc., for 2.20
Browse files Browse the repository at this point in the history
git-svn-id: svn://svn.tt2.org/tt/Template2/trunk@1168 d5a88997-0a34-4036-9ed2-92fb5d660d91
  • Loading branch information
abw committed Aug 13, 2008
1 parent 8c1caef commit ea1f16e
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 68 deletions.
19 changes: 0 additions & 19 deletions HACKING
Expand Up @@ -28,25 +28,6 @@ The internals document also contains information about preparing and
applying patches, updating the documentation and various other
useful tips.

The documentation is all built from source templates in the 'docsrc'
directory. This includes the 'README', 'INSTALL', 'HACKING' and
'Changes' files which can be found in the 'docsrc/src/Release'
directory. The 'docsrc' bundle is a separate distribution available
from the TT web site. The 'docsrc/bin' directory contains scripts for
rebuilding the documentation. See the 'docsrc/README' file for info.

If you're in the business of building a distribution (that usually
means me, but hey, you never know) then you'll need to have the latest
CVS sources which includes the 'bin/release' script. This rebuilds
the documentation, runs the tests, fixes up the Template/Config.pm
file to a sane state and builds the distribution archive. The
'bin/docsrc' script builds the docsrc.tar.gz distribution for the
latest release.

This document will be integrated with Template::Manual::Internals
at some point, probably as a separate hacking tutorial or something
similar.


AUTHOR
------
Expand Down
7 changes: 2 additions & 5 deletions INSTALL
Expand Up @@ -37,10 +37,7 @@ To install the Template Toolkit from the command line:
$ make test
$ make install

The Makefile.PL will prompt for additional configuration options,
including the installation of optional template libraries, HTML
documentation and examples. You can safely answer 'n' to all of these
questions for a quick and basic installation.
The Makefile.PL will prompt for any additional configuration options.

For further details, see the sections below on CONFIGURATION, BUILDING
AND TESTING, and INSTALLATION. The Template Toolkit web site also has
Expand Down Expand Up @@ -82,7 +79,7 @@ Interim and development versions may also be available, along with
other useful information, news, publications, mailing list archives,
etc., from the Template Toolkit web site:

http://www.template-toolkit.org/
http://template-toolkit.org/

The Template Toolkit is distributed as a gzipped tar archive file:

Expand Down
56 changes: 12 additions & 44 deletions README
Expand Up @@ -11,47 +11,17 @@
modify it under the same terms as Perl itself.


QUICK START (see INSTALL for further details)
-----------
INSTALLATION
------------

If you have the CPAN module installed then you can install the Template
Toolkit like this from the command line:
Toolkit from the command line like so:

$ cpan Template

Otherwise you can install from source code. The latest version of the Template
Toolkit can be retrieved from:

http://www.cpan.org/modules/by-module/Template/

Fetch and install AppConfig 1.56 if you don't already have it installed.
Available from CPAN in:

http://www.cpan.org/authors/Andy_Wardley/

To install the Template Toolkit from the command line:

$ tar zxf Template-Toolkit-2.20.tar.gz
$ cd Template-Toolkit-2.20
$ perl Makefile.PL
$ make
$ make test
$ make install

The Makefile.PL will prompt for additional configuration options,
including the installation of optional template libraries, HTML
documentation and examples. You can safely answer 'n' to all of these
questions for a quick and basic installation.

If you're running ActivePerl on a Win32 platform then you can use the
Perl Package Manager (PPM) to install the Template Toolkit. Chris
Winters maintains a repository of pre-compiled PPM packages which contains
the Template Toolkit, AppConfig and others. For further information, see:

http://openinteract.sourceforge.net/

For further details on installation, see the separate INSTALL file
and http://template-toolkit.org/download/index.html
Please see the separate INSTALL file for further information on installing
the Template Toolkit, including what to do if you don't have the CPAN
module installed, and/or installation on MS Windows.


DESCRIPTION
Expand Down Expand Up @@ -201,9 +171,9 @@ planned enhancements and possible new features for future versions.

The 'INSTALL' file covers the configuration and installation process.

The rest of the documentation is distributed in Pod and HTML formats.
The Pod pages are installed when you 'make install' and can be viewed
using 'perldoc', e.g.
The rest of the documentation is distributed in Pod format. The Pod pages
are installed when you 'make install' and can be viewed using 'perldoc',
e.g.

perldoc Template

Expand All @@ -214,11 +184,9 @@ converted to manpages suring the 'make install'. Thus, you can also:

(the man pages shouldn't have any problems relating to older versions)

The HTML documentation and the means to rebuild it can be found in the
'docs' sub-directory of the installation root. If you opted to
have it built at installation time, then there should be an 'html'
directory within it containing the generated HTML built from the
source templates.
The documentation is also available in HTML format at the TT web site:

http://tt2.org/docs/

The documentation is now split into several sections. The 'Template'
page is now much shorter, containing information relating to the
Expand Down

0 comments on commit ea1f16e

Please sign in to comment.