Permalink
Browse files

Add autogenerated README.pod

  • Loading branch information...
1 parent 53b308b commit 19ab79f3f525e648f73b167e47b06bcaed066863 @dave0 committed May 22, 2010
Showing with 50 additions and 1 deletion.
  1. +5 −0 Makefile.PL
  2. +36 −0 README.pod
  3. +9 −1 gcode-issue-import
View
5 Makefile.PL
@@ -8,4 +8,9 @@ requires 'Net::GitHub' => '0.21';
install_script 'gcode-issue-import';
+postamble <<END_MAKE;
+readme:
+ perldoc -u gcode-issue-import > README.pod
+END_MAKE
+
WriteAll;
View
36 README.pod
@@ -0,0 +1,36 @@
+=head1 NAME
+
+gcode-issue-import - Import issues from Google Code into Github's issue tracker
+
+=head1 SYNOPSIS
+
+ gcode-issue-import your_googlecode_projectname owner/githubreponame
+
+=head1 DESCRIPTION
+
+This script aims to pull as much data as possible from Google Code's issue
+tracker and insert it into Github's issue tracker.
+
+This should be considered ALPHA-QUALITY CODE . Do not (yet) run it targeting a
+Github issue tracker that contains data you care about, or you may spend days
+manually deleting ugly tickets.
+
+Before using, you must first add your github user and token to your global
+.gitconfig, so that the script can access them. Then run it as specified in
+the synopsys.
+
+=head1 AUTHORS
+
+Dave O'Neill <dmo@dmo.ca>
+
+Based on google-code-to-github-issues.pl by Tatsuhiko Miyagawa
+(http://remediecode.org/2009/04/moved-issues-to-github.html)
+
+=head1 LICENSE
+
+This program is free softwarew; you can redistribute it and/or modify it
+under the same terms as Perl itself.
+
+
+=cut
+
View
10 gcode-issue-import
@@ -12,13 +12,21 @@ gcode-issue-import - Import issues from Google Code into Github's issue tracker
=head1 SYNOPSIS
- gcode-issue-import your_googlecode_projectname owner/githubreponame
+ gcode-issue-import your_googlecode_projectname owner/githubreponame
=head1 DESCRIPTION
This script aims to pull as much data as possible from Google Code's issue
tracker and insert it into Github's issue tracker.
+This should be considered ALPHA-QUALITY CODE . Do not (yet) run it targeting a
+Github issue tracker that contains data you care about, or you may spend days
+manually deleting ugly tickets.
+
+Before using, you must first add your github user and token to your global
+.gitconfig, so that the script can access them. Then run it as specified in
+the synopsys.
+
=head1 AUTHORS
Dave O'Neill <dmo@dmo.ca>

0 comments on commit 19ab79f

Please sign in to comment.