Basic information about file hierarchy in this Perl/ directory.

CVS version numbers

Perl/README: INITIAL -> 1.1

1 files changed, 29 insertions, 0 deletions

diff --git a/Perl/README b/Perl/README
new file mode 100644
index 00000000000..1367fa5e06b
--- /dev/null
+++ b/Perl/README
@@ -0,0 +1,29 @@
+   
+   Generation of the Debian web site involves many Perl scripts, so
+   instead of reinvent the wheel again and again, it is wise to invoke
+   regular CPAN modules and write our owns.
+   
+   As we do not have rights to install them outside of the webwml CVS
+   tree, and it would be a pain for translators to keep up-to-date
+   if we request them to install some Debian packages from unstable, 
+   this place contains all the needed stuff.
+   
+   There are three different hierarchies:
+      Webwml/           Modules devoted to www.debian.org generation,
+                        contain some w.d.o specific parts
+      Local/            Modules of general interest we have written
+                        (do not be confused by the CPAN Locale
+                        subdirectory)
+      <others>, *.pm    CPAN modules
+   
+   All modules must be Perl code without need of compilation.
+
+   In order to load these modules, top-level Perl script must
+   include this line before loading these modules:
+       use lib ($0 =~ m|(.*)/|, $1 or ".") ."/Perl";
+   Scripts located elsewhere must be adapted.
+
+   When some WML templates do use these modules too, this line
+       <: use lib "$(ENGLISHDIR)/../Perl"; :>
+   should be added at the right place.
+