summaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL51
1 files changed, 51 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..69ac173
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,51 @@
+Dependencies
+------------
+
+This package uses the following modules outside the Perl core:
+
+ * `CGI::SSI`
+
+Basic Installation
+------------------
+
+This software package uses Perl's `ExtUtils::MakeMaker` module to
+generate a build system.
+
+The `Makefile.PL` script configures the package to be built and
+installed on the system and generates a makefile.
+
+This package can be configured, built, and installed with the following
+commands:
+
+ $ perl Makefile.PL
+ $ make
+ $ make install
+
+Superuser privileges will probably be necessary to install the package
+on the system.
+
+Macros
+------
+
+The macro `DESTDIR` affects the root directory into which `Makefile`
+installs the package. For example, you can install the package into a
+filesystem hierarchy under a directory named `dest` in the current
+directory by running `make DESTDIR=dest install`.
+
+The macro `INSTALLDIRS` affects the set of directories into which
+`Makefile` installs the package's files. For example, you can install
+the package into system directories by running `make INSTALLDIRS=vendor
+install`.
+
+For more information on available targets and macros, see the
+documentation for `ExtUtils::MakeMaker`.
+
+Copyright Information
+---------------------
+
+Copyright (C) 2013 Patrick "P. J." McDermott
+
+Copying and distribution of this file, with or without modification,
+are permitted in any medium without royalty provided the copyright
+notice and this notice are preserved. This file is offered as-is,
+without any warranty.