vvelox
/
Git-PunchCard
1
0
Fork 0
Code Issues Pull Requests Releases 3 Wiki Activity

more documentation

This commit is contained in:
Zane C. B-H 2019-07-15 03:15:51 -05:00
parent d431e31f69
commit 2aa684a1e3
2 changed files with 44 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Git-PunchCard/README
View File

@ -1,15 +1,23 @@
Git-PunchCard
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.
The module gathers git commit information in a manner that can be used to generated
Github style punchard graphs.
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.
Included is a script that uses Term::ANSIColor and Text::Table to generated console
colorized information using the module.
Below is a example the output generated by the script.
00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 Total
Sun 41 41 28 26 11 15 16 28 36 43 58 63 69 97 125 144 96 134 134 148 110 160 124 57 1804
Mon 48 38 43 18 14 5 20 34 64 116 178 155 119 140 145 187 171 123 117 121 129 163 125 98 2371
Tue 63 51 37 21 13 42 33 73 104 166 163 137 136 141 209 200 188 117 121 132 138 138 167 130 2720
Wed 76 43 42 30 29 25 22 47 139 148 166 153 110 156 177 277 225 150 105 138 148 213 133 87 2839
Thu 66 49 38 41 23 28 23 27 92 124 144 183 138 148 173 199 194 132 90 113 124 156 170 115 2590
Fri 60 38 19 20 27 14 23 53 86 133 158 118 87 165 176 178 178 128 111 70 79 100 99 93 2213
Sat 83 62 30 22 27 24 16 27 54 61 81 98 87 91 112 107 116 103 88 81 85 83 121 81 1740
Total: 16277
INSTALLATION

28
Git-PunchCard/bin/punchcard-git
View File

@ -10,6 +10,15 @@ use Text::Table;
sub help{
&version;
print '
punchcard-git [<dir>]
--version Display the version.
--help Display this help info.
If no directory is specified, the current one is used.
';
exit;
}
@ -90,6 +99,9 @@ if ($help){
my $gpc=Git::PunchCard->new;
$gpc->dir( $ARGV[0] );
if ( $gpc->error ){
exit $gpc->error;
}
my $table=Text::Table->new(
'',
@ -140,4 +152,18 @@ foreach my $day ( @days ){
$table->load( @data );
print $table;
print $table."\nTotal: ".$card->{total}."\n";
=head1 NAME
punchard-git - Generate a punchard plot for git commits.
=head1 SYNOPSIS
punchard-git [<dir>]
=head1 ARGUMENTS
If <dir> is not specified, then the current directoy will be used.
=cut