import scgi engine

[catagits/Catalyst-Engine-SCGI.git] / README

diff --git a/README b/README
new file mode 100755 (executable)
index 0000000..22c64f3
--- /dev/null
+++ b/README
@@ -0,0 +1,49 @@
+Catalyst-Engine-SCGI
+
+The README is used to introduce the module and provide instructions on
+how to install the module, any machine dependencies it may have (for
+example C compilers and installed libraries) and any other information
+that should be provided before the module is installed.
+
+A README file is required for CPAN modules since CPAN extracts the README
+file from a module distribution so that people browsing the archive
+can use it get an idea of the modules uses. It is usually a good idea
+to provide version information here so that people can decide whether
+fixes for the module are worth downloading.
+
+INSTALLATION
+
+To install this module, run the following commands:
+
+    perl Makefile.PL
+    make
+    make test
+    make install
+
+
+SUPPORT AND DOCUMENTATION
+
+After installing, you can find documentation for this module with the perldoc command.
+
+    perldoc Catalyst::Engine::SCGI
+
+You can also look for information at:
+
+    Search CPAN
+        http://search.cpan.org/dist/Catalyst-Engine-SCGI
+
+    CPAN Request Tracker:
+        http://rt.cpan.org/NoAuth/Bugs.html?Dist=Catalyst-Engine-SCGI
+
+    AnnoCPAN, annotated CPAN documentation:
+        http://annocpan.org/dist/Catalyst-Engine-SCGI
+
+    CPAN Ratings:
+        http://cpanratings.perl.org/d/Catalyst-Engine-SCGI
+
+COPYRIGHT AND LICENCE
+
+Copyright (C) 2006 Victor Igumnov
+
+This program is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.