Permalink
Browse files

trying to sort out Fup git localy

  • Loading branch information...
1 parent 14c397d commit fde21cd4a55995e01b193fe936d774c9cfb1949f @kevindawson committed Mar 24, 2013
Showing with 53 additions and 68 deletions.
  1. +45 −59 README.md
  2. +6 −7 lib/App/Midgen.pm
  3. +2 −2 script/midgen
View
104 README.md
@@ -8,7 +8,7 @@ then display in a familiar format with the current version number from MetaCPAN.
This started as a way of generating the formatted contents for a
Module::Install::DSL Makefile.PL, which has now grown to support other output
-formats, as well as the ability to show dual-life and perl core modules,
+formats, as well as the ability to show **dual-life** and **perl core** modules,
This enables you to see which modules you have used,
All output goes to STDOUT, so you can use it as you see fit.
@@ -19,15 +19,14 @@ All output goes to STDOUT, so you can use it as you see fit.
Change to the root of the package you want to scan and run
- midgen
-
+ midgen
Now with a added Getopt --help or -?
- midgen -?
+ midgen -?
### Usage
- midgen [options]
+midgen [options]
--help brief help message
--format change output format
@@ -36,12 +35,12 @@ Now with a added Getopt --help or -?
--verbose take a little peek as to what is going on
--experimental this feature under development
--zero show a 0 instead of core
- --debug provides vast amount of output, re self dev
+ --debug provides vast amount of output, re self development
## Description
-**midgen** function is to search your Perl Module and find Includes **use** and **require** and then present them in a format which you can easily use.
-Besides finding the included Modules it also finds the current version.
+**midgen** function is to search your Perl Module and find Includes **use** and **require** and then present them
+in a format which you can easily use. Besides finding the included Modules it also finds the current version.
It try s to remove unwanted noise and duplication along the way.
* Ignores all sub modules of current Module
@@ -53,74 +52,61 @@ _Food for thought, if we update our Modules, don't we want our users to use the
## Options
- --help or -h or -?
- Print a brief help message and exits.
-
-
- --format or -f
- By default we output to STDOUT in 'dsl' format, so you can check,
- copy n paste or select an alternative format as shown below.
-
- midgen -f dsl # Module::Include::DSL
- midgen -f mi # Module::Include
- midgen -f build # Build
- midgen -f dzil # Dist::Zilla
- midgen -f dist # dist.ini
+####--help or -h or -?
+Print a brief help message and exits.
- --dual_life or -l
- Shows modules that are in Perl core and CPAN, some modules have a
- version number eg; constant, Carp
+ midgen -?
- midgen -l
+####--format or -f
+By default we output to STDOUT in 'dsl' format, so you can check, copy n paste or select an alternative format as shown below.
- --dual_life or -l
- Shows modules that are in Perl core and CPAN, some modules have a
- version number eg; constant, Carp
+ midgen -f dsl # Module::Include::DSL
+ midgen -f mi # Module::Include
+ midgen -f build # Build
+ midgen -f dzil # Dist::Zilla
+ midgen -f dist # dist.ini
- midgen -l
- --core or -c
- Shows all modules that are in Perl core, including dual-life, some
- have a version of 0 eg; strict, English
+####--dual_life or -l
+Shows modules that are in Perl core and CPAN, some modules have a
+version number eg; constant, Carp
- midgen -c
+ midgen -l
- --verbose or -v
- Show file names that we are checking, as we go
+####--core or -c
+Shows all modules that are in Perl core, including dual-life, some have a version of 0 eg; strict, English
- midgen -v
+ midgen -c
- --experimental or -x
- This experimental feature turns on extra passing, that removes twins
- and noisy_children, replacing them with there parent(dist), giving a
- minimalist output, you might conceive this as controversial, if so
- don't enable it.
+####--verbose or -v
+Show file names that we are checking, as we go
- midgen -x
+ midgen -v
- --zero or z
- Use a '0' instead of 'core' for core module version number, suggest
- you incorporate it with core for maximum affect
+####--experimental or -x
+This experimental feature turns on extra passing, that removes twins and noisy_children,
+replacing them with there parent(dist), giving a minimalist output, you might conceive this as controversial,
+if so don't enable it.
- midgen -cz
+ midgen -x
- --write or -w
- you can now write your current options to ~/.midgenrc in JSON format
- (core, dual_life, format, zero), to be used again. I you want to
- edit your ~./midgenrc file, you could use the Getopt --no-option to
- negate an option, or you can edit/delete the file, your choice.
+####--zero or z
+Use a '0' instead of 'core' for core module version number, suggest you incorporate it with core for maximum affect
- midgen --no-z -w
+ midgen -cz
- --debug or -d
- Provides a vast amount of output, relevant to development also
- enables (core, verbose)
+####--write or -w
+You can now write your current options to ~/.midgenrc in JSON format (core, dual_life, format, zero), to be used again.
+I you want to edit your ~./midgenrc file, you could use the Getopt --no-option to negate an option,
+or you can edit/delete the file, your choice.
- uses Data::Printer
+ midgen --no-z -w
- suggest you consider redirecting STDERR when the debug option is
- used
+####--debug or -d
+Provides a vast amount of output, relevant to development also enables (core, verbose)
- midgen -d 2>debug.txt
+uses Data::Printer
+Suggest you consider redirecting STDERR when the debug option is used
+ midgen -d 2>debug.txt
View
@@ -905,11 +905,11 @@ the package,
then display in a familiar format with the current version number
from MetaCPAN.
-This started out as a way of generating the formatted contents for
-a Module::Install::DSL Makefile.PL,
-you can now see the B<dual-life> and B<perl core> modules as well,
-this enables you to see which modules you have used,
-yes it's another L<PPI> powered app.
+This started as a way of generating the formatted contents for
+a Module::Install::DSL Makefile.PL, which has now grown to support other
+output formats, as well as the ability to show B<dual-life> and
+B<perl core> modules, see L<midgen> for option info.
+This enables you to see which modules you have used,
All output goes to STDOUT, so you can use it as you see fit.
@@ -988,10 +988,9 @@ catching triplets along the way.
App::Midgen requires no configuration files or environment variables.
-
=head1 DEPENDENCIES
-L<App::Midgen::Roles>, L<App::Midgen::Output>,
+L<App::Midgen::Roles>, L<App::Midgen::Output>
=head1 INCOMPATIBILITIES
View
@@ -8,7 +8,7 @@ BEGIN {
$PPI::XS_DISABLE = 1; # noise control - Prevent warning
}
-our $VERSION = '0.17_03';
+our $VERSION = '0.18';
use English qw( -no_match_vars ); # Avoids reg-ex performance penalty
local $OUTPUT_AUTOFLUSH = 1;
@@ -131,7 +131,7 @@ midgen - Check B<requires> & B<test_requires> of your package for CPAN inclusion
=head1 VERSION
-This document describes midgen version: 0.17_03
+This document describes midgen version: 0.18
=head1 SYNOPSIS

0 comments on commit fde21cd

Please sign in to comment.