v3.25 release
[perl/plp/.git] / README
diff --git a/README b/README
index d21d1f03cbfdca6baadded64a9cfa7af77858368..771dcb1c1d919139c5142cb451262c51206f4d6c 100644 (file)
--- a/README
+++ b/README
@@ -1,62 +1,35 @@
-NAME
-    PLP - Perl in HTML pages
+PLP - PERL IN HTML PAGES
 
-MODULE INSTALLATION
+PLP is yet another Perl embedder, primarily for HTML documents. Unlike
+with other Perl embedders, there is no need to learn a meta-syntax or
+object model: one can just use the normal Perl constructs. PLP runs
+under FastCGI and mod_perl for speeds comparable to those of PHP, but
+can also be run as a standard CGI script.
+
+INSTALLATION
+
+To install this module, run the following commands:
 
     perl Makefile.PL
     make
+    make test
     make install
 
-SYNOPSIS
-  mod_perl installation
-    * httpd.conf (for mod_perl setup)
-                  <Files *.plp>
-                      SetHandler perl-script
-                      PerlHandler PLP
-                      PerlSendHeader On
-                  </Files>
-
-                  # Who said CGI was easier to set up? :)
-
-  CGI installation
-    * /foo/bar/plp.cgi (local filesystem address)
-                  #!/usr/bin/perl
-                  use PLP;
-                  PLP::everything();
-
-    * httpd.conf (for CGI setup)
-                  ScriptAlias /foo/bar/ /PLP_COMMON/
-                  <Directory /foo/bar/>
-                      AllowOverride None
-                      Options +ExecCGI
-                      Order allow,deny
-                      Allow from all
-                  </Directory>
-                  AddHandler plp-document plp
-                  Action plp-document /PLP_COMMON/plp.cgi
-
-  Test script (test.plp)
-        <html><body>
-        <:
-            print "Hurrah, it works!<br>" for 1..10;
-        :>
-        </body></html>
-
-DESCRIPTION
-    PLP is yet another Perl embedder, primarily for HTML documents. Unlike
-    with other Perl embedders, there is no need to learn a meta-syntax or
-    object model: one can just use the normal Perl constructs. PLP runs
-    under mod_perl for speeds comparable to those of PHP, but can also be
-    run as a CGI script.
-
-WEBSITE
-    For now, all documentation is on the website. Everything will be POD one
-    day, but until that day, you will need to visit http://plp.juerd.nl/
-
-NO WARRANTY
-    No warranty, no guarantees. Use PLP at your own risk, as I disclaim all
-    responsibility.
-
-AUTHOR
-    Juerd Waalboer <juerd@juerd.nl>
+SUPPORT AND DOCUMENTATION
+
+After installing, documentation will be installed as manual pages:
+
+    man PLP
+
+It can also be found at CPAN:
+
+    http://search.cpan.org/dist/PLP
+
+COPYRIGHT
+
+Copyright (c) 2000-2002 Juerd Waalboer, 2005-2018 Mischa POSLAWSKY.
+All rights reserved.
+
+This software is free software; you can redistribute and/or modify it
+under the terms of the MIT/X11 license (see COPYING).