summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMark Wells <mark@freeside.biz>2012-11-02 14:28:31 -0700
committerMark Wells <mark@freeside.biz>2012-11-02 14:28:31 -0700
commit7be09bed7f9acdf8a20362c49831dfb39fc4e7a4 (patch)
tree51ed1f3337fd567897a12553fe6a6ae2ced3ce7c /README
initial commit
Diffstat (limited to 'README')
-rw-r--r--README55
1 files changed, 55 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..e7c2877
--- /dev/null
+++ b/README
@@ -0,0 +1,55 @@
+Geo-EZLocate
+
+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 to get an idea of the module's 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, run the following commands:
+
+ perl Makefile.PL
+ make
+ make test
+ make install
+
+SUPPORT AND DOCUMENTATION
+
+After installing, you can find documentation for this module with the
+perldoc command.
+
+ perldoc Geo::EZLocate
+
+You can also look for information at:
+
+ RT, CPAN's request tracker (report bugs here)
+ http://rt.cpan.org/NoAuth/Bugs.html?Dist=Geo-EZLocate
+
+ AnnoCPAN, Annotated CPAN documentation
+ http://annocpan.org/dist/Geo-EZLocate
+
+ CPAN Ratings
+ http://cpanratings.perl.org/d/Geo-EZLocate
+
+ Search CPAN
+ http://search.cpan.org/dist/Geo-EZLocate/
+
+
+LICENSE AND COPYRIGHT
+
+Copyright (C) 2012 Mark Wells
+
+This program is free software; you can redistribute it and/or modify it
+under the terms of either: the GNU General Public License as published
+by the Free Software Foundation; or the Artistic License.
+
+See http://dev.perl.org/licenses/ for more information.
+