summaryrefslogtreecommitdiff
path: root/bindings/swig/perl/README
diff options
context:
space:
mode:
Diffstat (limited to 'bindings/swig/perl/README')
-rw-r--r--bindings/swig/perl/README35
1 files changed, 35 insertions, 0 deletions
diff --git a/bindings/swig/perl/README b/bindings/swig/perl/README
new file mode 100644
index 0000000..af3aace
--- /dev/null
+++ b/bindings/swig/perl/README
@@ -0,0 +1,35 @@
+sword version 1.5.5
+===================
+
+The README is used to introduce the module and provide instructions on
+how to install the module, any machine dependencies it may have (for
+example C compilers and installed libraries) and any other information
+that should be provided before the module is installed.
+
+A README file is required for CPAN modules since CPAN extracts the
+README file from a module distribution so that people browsing the
+archive can use it get an idea of the modules uses. It is usually a
+good idea to provide version information here so that people can
+decide whether fixes for the module are worth downloading.
+
+INSTALLATION
+
+To install this module type the following:
+
+ perl Makefile.PL
+ make
+ make test
+ make install
+
+DEPENDENCIES
+
+This module requires these other modules and libraries:
+
+ blah blah blah
+
+COPYRIGHT AND LICENCE
+
+Put the correct copyright and licence information here.
+
+Copyright (C) 2002 Crosswire Bible Society
+