summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README50
1 files changed, 50 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..0792f23
--- /dev/null
+++ b/README
@@ -0,0 +1,50 @@
+webx_type
+
+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 webx_type
+
+You can also look for information at:
+
+ RT, CPAN's request tracker (report bugs here)
+ https://rt.cpan.org/NoAuth/Bugs.html?Dist=webx_type
+
+ CPAN Ratings
+ https://cpanratings.perl.org/d/webx_type
+
+ Search CPAN
+ https://metacpan.org/release/webx_type
+
+
+LICENSE AND COPYRIGHT
+
+This software is Copyright (c) 2022 by Jake Thoughts.
+
+This is free software, licensed under:
+
+ The GNU General Public License, Version 3, June 2007
+