Blame README

Packit e8529c
NAME
Packit e8529c
    Module::Install::AutoLicense - A Module::Install extension to
Packit e8529c
    automagically generate LICENSE files
Packit e8529c
Packit e8529c
SYNOPSIS
Packit e8529c
      # In Makefile.PL
Packit e8529c
Packit e8529c
      use inc::Module::Install;
Packit e8529c
      author 'Vestan Pants';
Packit e8529c
      license 'perl';
Packit e8529c
      auto_license;
Packit e8529c
Packit e8529c
    An appropriate "LICENSE" file will be generated for your distribution.
Packit e8529c
Packit e8529c
DESCRIPTION
Packit e8529c
    Module::Install::AutoLicense is a Module::Install extension that
Packit e8529c
    generates a "LICENSE" file automatically whenever the author runs
Packit e8529c
    "Makefile.PL". On the user side it does nothing.
Packit e8529c
Packit e8529c
    When "make distclean" is invoked by the author, the "LICENSE" is
Packit e8529c
    removed.
Packit e8529c
Packit e8529c
    The appropriate license to determined from the meta provided with the
Packit e8529c
    "license" command and the holder of the license from the "author"
Packit e8529c
    command.
Packit e8529c
Packit e8529c
    Software::License is used to generate the "LICENSE" file.
Packit e8529c
Packit e8529c
COMMANDS
Packit e8529c
    This plugin adds the following Module::Install command:
Packit e8529c
Packit e8529c
    "auto_license"
Packit e8529c
        Does nothing on the user-side. On the author-side it will generate a
Packit e8529c
        "LICENSE" file according to the previously supplied "license"
Packit e8529c
        command. The "holder" of the license is determined from the "author"
Packit e8529c
        meta or may be specified using the "holder" parameter.
Packit e8529c
Packit e8529c
          auto_license( holder => 'Vestan Pants and Ivor Biggun' );
Packit e8529c
Packit e8529c
        It is important to note that the "auto_license" must follow "author"
Packit e8529c
        and "license" commands in the "Makefile.PL" ( as demonstrated in the
Packit e8529c
        SYNOPSIS above ), otherwise the meta these commands provide will be
Packit e8529c
        unavailable to "auto_license". Call it a feature.
Packit e8529c
Packit e8529c
AUTHOR
Packit e8529c
    Chris "BinGOs" Williams
Packit e8529c
Packit e8529c
LICENSE
Packit e8529c
    Copyright © Chris Williams
Packit e8529c
Packit e8529c
    This module may be used, modified, and distributed under the same terms
Packit e8529c
    as Perl itself. Please see the license that came with your Perl
Packit e8529c
    distribution for details.
Packit e8529c
Packit e8529c
SEE ALSO
Packit e8529c
    Module::Install
Packit e8529c
Packit e8529c
    Software::License
Packit e8529c