[libmarpa-r2-perl] 20/32: Documenting installation.

[Jonas Smedegaard]

This is an automated email from the git hooks/post-receive script.

js pushed a commit to annotated tag Marpa-R2-2.087_000
in repository libmarpa-r2-perl.

commit aa2f9d63f1fae8a7501bd90d524d6f1ab633c9c7
Author: Jeffrey Kegler <JKEGL at cpan.org>
Date:   Sat Jul 5 19:17:23 2014 -0700

    Documenting installation.
---
 cpan/INSTALL     | 25 +++++++++++++++++++++++++
 cpan/README      |  2 ++
 cpan/core/README | 23 +++++++++++++++++++++++
 cpan/core/STATIC | 15 +++++++++++++++
 4 files changed, 65 insertions(+)

diff --git a/cpan/INSTALL b/cpan/INSTALL
new file mode 100644
index 0000000..6db5648
--- /dev/null
+++ b/cpan/INSTALL
@@ -0,0 +1,25 @@
+BASIC INSTALLATION
+
+To install this module, just do:
+ 
+  perl Build.PL
+  ./Build
+  ./Build test
+  ./Build install  (this step may need to be done as the superuser)
+ 
+Or, if you're on a platform (like DOS or Windows) that doesn't require
+the "./" notation, you can do this:
+ 
+  perl Build.PL
+  Build
+  Build test
+  Build install
+ 
+The important thing is that the "Build" script gets executed and that
+you pass it the "test", "install", etc. arguments.
+ 
+ADVANCED INSTALLATION
+
+Most users will want to stick to the basic installation method of this
+document.  Re-packagers, and other adventurers, will find alternative
+methods discussed in the core/ALTERNATIVES document.
diff --git a/cpan/README b/cpan/README
index 0061cad..b5d963e 100644
--- a/cpan/README
+++ b/cpan/README
@@ -1 +1,3 @@
 This is the R2 version of the Marpa module.
+Installation is discussed in the INSTALL document.
+Licensing is discussed in the LICENSE document.
diff --git a/cpan/core/README b/cpan/core/README
new file mode 100644
index 0000000..a6eaadc
--- /dev/null
+++ b/cpan/core/README
@@ -0,0 +1,23 @@
+This directory contains the Libmarpa code used in the basic installation
+method, the one supported by the CPAN infrasture.  It also contains
+documents describing alternative ways of using Libmarpa -- external
+static libraries and external shared libraries.
+
+The code in the "core" subdirectory should *NOT* be used for building
+a separate Libmarpa.  It is specifically targeted at the needs of Perl
+builds, and may contain specials kludges and hacks.
+
+If you want to build your own separate Libmarpa, build a distribution, or
+build a distribution tar file, from Libmarpa's repository.  Instructions
+on how to build distribution directories and tar files are in the INSTALL
+file at the top level of the repository.  Libmarpa's repository is here:
+https://github.com/jeffreykegler/libmarpa
+
+As an advanced technique, Marpa::R2 can be linked with external static
+or shared Libmarpa libraries.  Use of external Libmapra libraries is
+*NOT* supported by the CPAN infrastructure, which does not deal well
+with non-Perl dependencies.
+
+For more on linking with an external static library, see the STATIC file
+in this directory.  For more on linking with an external shared library,
+see the SHARED file in this directory.
diff --git a/cpan/core/STATIC b/cpan/core/STATIC
new file mode 100644
index 0000000..fca4ae5
--- /dev/null
+++ b/cpan/core/STATIC
@@ -0,0 +1,15 @@
+This document describes how to link an external static library with
+Marpa::R2.  This method, and this document, is intended for re-packagers
+and other very advanced users.  This method is not supported by the CPAN
+infrastructure.  Most users should perfer the basic method described in
+the INSTALL document at the top level of the Marpa::R2 CPAN directory.
+
+Here are the steps:
+
+1.) Build an external static library using the separate Libmarpa
+repository.  Libmarpa uses autoconf.  Instructions on how to
+build it can be found beginning in the INSTALL file at the top
+level of the Libmarpa repository.  Libmarpa's repository is here:
+https://github.com/jeffreykegler/libmarpa
+
+[ INCOMPLETE !!! ]

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libmarpa-r2-perl.git