Changes entry for DDS prereq

[p5sagit/Devel-REPL.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index a1dc193..00edb6d 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,14 +1,43 @@
-WHAT IS THIS?
+This is the Perl distribution Devel-REPL.
 
-This is Devel::REPL, an interactive Perl shell.
-Please see the README that comes with this distribution.
+Installing Devel-REPL is straightforward.
 
-HOW DO I INSTALL IT?
+## Installation with cpanm
 
-To install this module, cd to the directory that contains this README
-file and type the following:
+If you have cpanm, you only need one line:
 
-   perl Makefile.PL
-   make
-   make test
-   make install
+    % cpanm Devel::REPL
+
+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 Devel::REPL
+
+## Installing with the CPAN shell
+
+Alternatively, if your CPAN shell is set up, you should just be able to do:
+
+    % cpan Devel::REPL
+
+## Manual installation
+
+As a last resort, you can manually install it. Download the tarball, untar it,
+then build it:
+
+    % perl Makefile.PL
+    % make && make test
+
+Then install it:
+
+    % make install
+
+If you are installing into a system-wide directory, you may need to run:
+
+    % sudo make install
+
+## Documentation
+
+Devel-REPL documentation is available as POD.
+You can run perldoc from a shell to read the documentation:
+
+    % perldoc Devel::REPL