summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorLorry Tar Creator <lorry-tar-importer@lorry>2014-09-15 02:32:09 +0000
committerLorry Tar Creator <lorry-tar-importer@lorry>2014-09-15 02:32:09 +0000
commit5f549fcb4056f8b314c7f7336a020ef9735fb384 (patch)
tree9c0b4c2b5b28e525fc59010fa458553a7e6a4b1b /INSTALL
downloadPath-Class-tarball-5f549fcb4056f8b314c7f7336a020ef9735fb384.tar.gz
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL44
1 files changed, 44 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..1f08b29
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,44 @@
+
+This is the Perl distribution Path-Class.
+
+Installing Path-Class is straightforward.
+
+## Installation with cpanm
+
+If you have cpanm, you only need one line:
+
+ % cpanm Path::Class
+
+If you are installing into a system-wide directory, you may need to pass the
+"-S" flag to cpanm, which uses sudo to install the module:
+
+ % cpanm -S Path::Class
+
+## Installing with the CPAN shell
+
+Alternatively, if your CPAN shell is set up, you should just be able to do:
+
+ % cpan Path::Class
+
+## Manual installation
+
+As a last resort, you can manually install it. Download the tarball, untar it,
+then build it:
+
+ % perl Build.PL
+ % ./Build && ./Build test
+
+Then install it:
+
+ % ./Build install
+
+If you are installing into a system-wide directory, you may need to run:
+
+ % sudo ./Build install
+
+## Documentation
+
+Path-Class documentation is available as POD.
+You can run perldoc from a shell to read the documentation:
+
+ % perldoc Path::Class