diff --git a/README b/README deleted file mode 100644 index ecc02d8..0000000 --- a/README +++ /dev/null @@ -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. - - diff --git a/README.xml b/README.xml new file mode 100755 index 0000000..b1a6ecf --- /dev/null +++ b/README.xml @@ -0,0 +1,70 @@ + +Parse::RPM::Spec + + + +WHAT IS Parse::RPM::Spec? +Parse::RPM::Spec is a Perl module which models RPM spec files. + + + +HOW DO I INSTALL IT? + +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: + +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 + +Where X.XX is the version number of the module which you are +installing. + +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/. + + + +WHERE IS THE DOCUMENTATION? + +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 + +perldoc Parse::RPM::Spec + +at a comand prompt. + + + +LATEST VERSION + +The latest version of this module will always be available from +CPAN. + + + +COPYRIGHT + +Copyright (C) 2008, Magnum Solutions Ltd. All Rights Reserved. + +This module is free software; you can redistribute it and/or +modify it under the same terms as Perl itself. + + + +ANYTHING ELSE? + +If you have any further questions, please contact the author. + + + + +Dave Cross dave@mag-sol.com + +