git.sur5r.net Git - i3/i3/blob - README

   1 AnyEvent-I3
   2
   3 The README is used to introduce the module and provide instructions on
   4 how to install the module, any machine dependencies it may have (for
   5 example C compilers and installed libraries) and any other information
   6 that should be provided before the module is installed.
   7
   8 A README file is required for CPAN modules since CPAN extracts the README
   9 file from a module distribution so that people browsing the archive
  10 can use it to get an idea of the module's uses. It is usually a good idea
  11 to provide version information here so that people can decide whether
  12 fixes for the module are worth downloading.
  13
  14
  15 INSTALLATION
  16
  17 To install this module, run the following commands:
  18
  19         perl Makefile.PL
  20         make
  21         make test
  22         make install
  23
  24 SUPPORT AND DOCUMENTATION
  25
  26 After installing, you can find documentation for this module with the
  27 perldoc command.
  28
  29     perldoc AnyEvent::I3
  30
  31 You can also look for information at:
  32
  33     RT, CPAN's request tracker
  34         http://rt.cpan.org/NoAuth/Bugs.html?Dist=AnyEvent-I3
  35
  36     AnnoCPAN, Annotated CPAN documentation
  37         http://annocpan.org/dist/AnyEvent-I3
  38
  39     CPAN Ratings
  40         http://cpanratings.perl.org/d/AnyEvent-I3
  41
  42     Search CPAN
  43         http://search.cpan.org/dist/AnyEvent-I3/
  44
  45
  46 LICENSE AND COPYRIGHT
  47
  48 Copyright (C) 2010 Michael Stapelberg
  49
  50 This program is free software; you can redistribute it and/or modify it
  51 under the terms of either: the GNU General Public License as published
  52 by the Free Software Foundation; or the Artistic License.
  53
  54 See http://dev.perl.org/licenses/ for more information.
  55