=================================================================== RCS file: /cvs/HOPE/Net-OpenAMD/Attic/README,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- HOPE/Net-OpenAMD/Attic/README 2010/06/24 22:45:25 1.1 +++ HOPE/Net-OpenAMD/Attic/README 2010/06/24 23:23:11 1.2 @@ -1,45 +1,77 @@ -Net-OpenAMD version 0.0.1 +NAME + Net::OpenAMD - Perl interface to the OpenAMD API -[ REPLACE THIS... +VERSION + This document describes Net::OpenAMD version 0.0.1 - 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 understood before the module is installed. +SYNOPSIS + use Net::OpenAMD; - 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. -] +DESCRIPTION + This module is to make it easy to grab information from the OpenAMD + project at The Next Hope. + http://amd.hope.net/ -INSTALLATION + http://amd.hope.net/2010/05/openamd-api-released-v1-1-1/ -To install this module, run the following commands: +INTERFACE +DIAGNOSTICS + "Error message here, perhaps with %s placeholders" + [Description of error here] - perl Makefile.PL - make - make test - make install + "Another error message here" + [Description of error here] -Alternatively, to install with Module::Build, you can use the following commands: + [Et cetera, et cetera] - perl Build.PL - ./Build - ./Build test - ./Build install +CONFIGURATION AND ENVIRONMENT + Net::OpenAMD requires no configuration files or environment variables. - DEPENDENCIES + LWP::UserAgent + Net::OAuth + JSON::Any -None. +INCOMPATIBILITIES + None reported. +BUGS AND LIMITATIONS + No bugs have been reported. -COPYRIGHT AND LICENCE + Please report any bugs or feature requests to + "bug-net-openamd@rt.cpan.org", or through the web interface at + . -Copyright (C) 2010, Andrew Fresh +AUTHOR + Andrew Fresh "" -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +LICENSE AND COPYRIGHT + Copyright (c) 2010, Andrew Fresh "". All rights + reserved. + + This module is free software; you can redistribute it and/or modify it + under the same terms as Perl itself. See perlartistic. + +DISCLAIMER OF WARRANTY + BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY + FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN + OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES + PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER + EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE + ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH + YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL + NECESSARY SERVICING, REPAIR, OR CORRECTION. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING + WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR + REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE + TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR + CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE + SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING + RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A + FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF + SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH + DAMAGES. +