increment $VERSION after 1.003029 release

[p5sagit/Devel-REPL.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index a1dc193..87f6307 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,14 +1,75 @@
-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 it does not have permission to install modules to the current perl, cpanm
+will automatically set up and install to a local::lib in your home directory.
+See the local::lib documentation (https://metacpan.org/pod/local::lib) for
+details on enabling it in your environment.
+
+## 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. If you have not already
+downloaded the release tarball, you can find the download link on the module's
+MetaCPAN page: https://metacpan.org/pod/Devel::REPL
+
+Untar the tarball, install configure prerequisites (see below), then build it:
+
+    % perl Makefile.PL
+    % make && make test
+
+Then install it:
+
+    % make install
+
+On Windows platforms, you should use `dmake` or `nmake`, instead of `make`.
+
+If your perl is system-managed, you can create a local::lib in your home
+directory to install modules to. For details, see the local::lib documentation:
+https://metacpan.org/pod/local::lib
+
+The prerequisites of this distribution will also have to be installed manually. The
+prerequisites are listed in one of the files: `MYMETA.yml` or `MYMETA.json` generated
+by running the manual build process described above.
+
+## Configure Prerequisites
+
+This distribution requires other modules to be installed before this
+distribution's installer can be run.  They can be found under the
+"configure_requires" key of META.yml or the
+"{prereqs}{configure}{requires}" key of META.json.
+
+## Other Prerequisites
+
+This distribution may require additional modules to be installed after running
+Makefile.PL.
+Look for prerequisites in the following phases:
+
+* to run make, PHASE = build
+* to use the module code itself, PHASE = runtime
+* to run tests, PHASE = test
+
+They can all be found in the "PHASE_requires" key of MYMETA.yml or the
+"{prereqs}{PHASE}{requires}" key of MYMETA.json.
+
+## Documentation
+
+Devel-REPL documentation is available as POD.
+You can run `perldoc` from a shell to read the documentation:
+
+    % perldoc Devel::REPL
+
+For more information on installing Perl modules via CPAN, please see:
+https://www.cpan.org/modules/INSTALL.html