Skip to content

Commit

Permalink
Added README.xml
Browse files Browse the repository at this point in the history
  • Loading branch information
davorg committed Oct 23, 2004
1 parent a4aa167 commit fa593b4
Showing 1 changed file with 76 additions and 0 deletions.
76 changes: 76 additions & 0 deletions README.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<?xml version="1.0" encoding="UTF-8"?>
<README>
<NAME>Tie::Hash::Cannabinol</NAME>
<DESCRIPTION>
<SUBSECTION>
<HEAD>WHAT IS Tie::Hash::Cannabinol?</HEAD>

<TEXT>Tie::Hash::Cannabinol is a Perl module which "extends" the
functionality of Perl hashes so that they forget almost anything
you tell them.</TEXT>
</SUBSECTION>

<SUBSECTION>
<HEAD>HOW DO I INSTALL IT?</HEAD>

<TEXT>Tie::Hash::Cannabinol uses the standard Perl module architecture and can
therefore be installed using the standard Perl method which, in brief, goes
something like this:</TEXT>

<CODE> gzip -cd Tie-Hash-Cannabinol-X.XX.tar.gz | tar xvf -
cd Tie-Hash-Cannabinol-X.XX
perl Makefile.PL
make
make test
make install
</CODE>

<TEXT>Where X.XX is the version number of the module which you are
installing.</TEXT>

<TEXT>If this doesn't work for you then creating a directory called Tie/Hash
somewhere in your Perl library path (@INC) and copying the Cannabinol.pm file
into this directory should also do the trick.</TEXT>
</SUBSECTION>

<SUBSECTION>
<HEAD>WHERE IS THE DODUMENTATION?</HEAD>

<TEXT>All of the documentation is currently in POD format in the Cannabinol.pm
file. If you install the module using the standard method you should be able
to read it by typing</TEXT>

<CODE> perldoc Tie::Hash::Cannabinol
</CODE>

<TEXT>at a comand prompt.</TEXT>
</SUBSECTION>

<SUBSECTION>
<HEAD>LATEST VERSION</HEAD>

<TEXT>The latest version of this module will always be available from
CPAN.</TEXT>
</SUBSECTION>

<SUBSECTION>
<HEAD>COPYRIGHT</HEAD>

<TEXT>Copyright (c) 2001, Magnum Solutions Ltd. All Rights Reserved.</TEXT>

<TEXT>This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.</TEXT>
</SUBSECTION>

<SUBSECTION>
<HEAD>ANYTHING ELSE?</HEAD>

<TEXT>If you have any further questions, please contact the author.</TEXT>
</SUBSECTION>
</DESCRIPTION>

<AUTHOR>
<ANAME>Dave Cross</ANAME> <EMAIL>dave@mag-sol.com</EMAIL>
</AUTHOR>
</README>

0 comments on commit fa593b4

Please sign in to comment.