Xiong Changnian

NAME

Cheat::Meta - Copy-and-paste usage lines for lazy coders

VERSION

This document describes Cheat::Meta version 0.0.5

SYNOPSIS

    $ perl -MCPAN -e 'install Cheat::Meta'

DESCRIPTION

If a thing is worth having, it's worth cheating for. --W. C. Fields

This is a collection of "cheat sheets": highly compressed, abbreviated documentation for various modules. Each module within the bundle covers a top-level namespace or a set of otherwise closely-related modules.

For each module, a paragraph is given, generally:

    Some::Module            # Short description
        qw( various exportable symbols if any );
        routine( $placeholder, @arguments );
        $context    = function( @arguments);
        $object->method();

You should be able to copy and paste this into your own code, delete what you don't need, and be on your way.

Files

Each cheat sheet comes in two formats. Both are installed into your Perl library as if they were modules, according to your installer configuration.

lib/Cheat/Sheet/Foo.perl - Plain Perl code suitable for opening in the editor of your choice.

lib/Cheat/Sheet/Foo.pod - The same content organized as a POD file.

You can also get the same content in your pager with:

    perldoc Cheat::Sheet::Foo

DEVELOPERS

Of course, if you have any interest in module cheat sheets, you're developing something in Perl. Check out the cheats.

If you want to develop cheat sheets themselves, kindly check out Cheat::Meta::Spec for the gory details.

SEE ALSO

BUGS AND LIMITATIONS

No cheat sheet will teach you anything. It's only a reminder. You must consult each module's own full documentation at least before using it. I hope.

THANKS

  • To about 8500 authors who have uploaded about 85,000 modules to the CPAN.

AUTHOR

Xiong Changnian <xiong@cpan.org>

LICENSE

Copyright (C) 2010, 2011 Xiong Changnian <xiong@cpan.org>

This library and its contents are released under Artistic License 2.0:

http://www.opensource.org/licenses/artistic-license-2.0.php