Removed README and added README.xml

This commit is contained in:
Dave Cross 2008-08-25 14:18:59 +00:00
parent bd4c969a26
commit 507c63f62e
2 changed files with 70 additions and 40 deletions

40
README
View file

@ -1,40 +0,0 @@
Parse-RPM-Spec version 0.01
===========================
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) 2008 by Dave Cross
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.10.0 or,
at your option, any later version of Perl 5 you may have available.

70
README.xml Executable file
View file

@ -0,0 +1,70 @@
<README>
<NAME>Parse::RPM::Spec</NAME>
<DESCRIPTION>
<SUBSECTION>
<HEAD>WHAT IS Parse::RPM::Spec?</HEAD>
<TEXT>Parse::RPM::Spec is a Perl module which models RPM spec files.</TEXT>
</SUBSECTION>
<SUBSECTION>
<HEAD>HOW DO I INSTALL IT?</HEAD>
<TEXT>Parse::RPM::Spec uses the standard Perl module architecture and can
therefore by installed using the standard Perl method which, in
brief, goes something like this:</TEXT>
<CODE>gzip -cd Parse-RPM-Spec-X.XX.tar.gz | tar xvf -
cd Parse-RPM-Spec-X.XX
perl Build.PL
./Build
./Build test
./Build install</CODE>
<TEXT>Where X.XX is the version number of the module which you are
installing.</TEXT>
<TEXT>You can also install it using either the CPAN shell (cpan) or the
CPANPLUS shell (cpanp). RPMs of this package will be available at
http://rpm.mag-sol.com/.</TEXT>
</SUBSECTION>
<SUBSECTION>
<HEAD>WHERE IS THE DOCUMENTATION?</HEAD>
<TEXT>All of the documentation is currently in POD format in the Parse.pm
file. If you install the module using the standard method you should
be able to read it by typing</TEXT>
<CODE>perldoc Parse::RPM::Spec</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) 2008, 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>