Permalink
Browse files

better documentation, link to github

  • Loading branch information...
1 parent 5b1d101 commit c9333f9fa52bb94fc812e235c75fd20f54c34c1e @andrefs committed Mar 24, 2012
Showing with 63 additions and 43 deletions.
  1. +1 −1 Build.PL
  2. +3 −3 Makefile.PL
  3. +51 −1 bin/texmine
  4. +8 −38 lib/App/TeXMine.pm
View
@@ -13,7 +13,7 @@ my $builder = Module::Build->new(
'App::Rad' => 0,
},
requires => {
- 'perl' => 5.010,
+ 'perl' => 5.014,
},
add_to_cleanup => [ 'App-TeXMine-*' ],
create_makefile_pl => 'traditional',
View
@@ -1,10 +1,10 @@
# Note: this file was auto-generated by Module::Build::Compat version 0.3800
-require 5.010;
+require 5.014;
use ExtUtils::MakeMaker;
WriteMakefile
(
- 'NAME' => 'App::texmine',
- 'VERSION_FROM' => 'lib/App/texmine.pm',
+ 'NAME' => 'App::TeXMine',
+ 'VERSION_FROM' => 'lib/App/TeXMine.pm',
'PREREQ_PM' => {
'App::Rad' => 0,
'Test::More' => 0
View
@@ -1,7 +1,7 @@
#!/usr/bin/env perl
use strict; use warnings;
use 5.14.1;
-use App::Rad qw/+App::texmine/;
+use App::Rad qw/+App::TeXMine/;
App::Rad->run();
sub img
@@ -27,3 +27,53 @@ sub index
my $c = shift;
return $c->index_cmd;
}
+
+=head1 NAME
+
+texmine - extract information from LaTeX files
+
+=head1 SYNOPSIS
+
+texmine [command] file.tex
+
+Run C<texmine help> for more options.
+
+=head1 COMMANDS
+
+=over 4
+
+=item B<index>
+
+Extract the table of contents (generated from the \chapter,\section
+and \subsection commands found).
+
+=item B<url>
+
+Extract all the URLs mentioned (generated from the \url commands
+found).
+
+=item B<bib>
+
+Extract all the citations used (generated from the \cite commands
+found).
+
+=item B<img>
+
+Extract all the image references found (generated from the
+\pgfimage and \includegraphics commands found).
+
+=back
+
+=head1 SEE ALSO
+
+L<App::TeXMine>
+
+=head1 COPYRIGHT
+
+Copyright 2012 Andre Santos.
+
+=head1 AUTHOR
+
+Andre Santos
+
+=cut
View
@@ -1,21 +1,21 @@
package App::TeXMine;
-use 5.006;
+use 5.014;
use strict;
use warnings;
use feature 'say';
=head1 NAME
-App::texmine - extract information from LaTeX files
+App::TeXMine - extract information from LaTeX files
=head1 VERSION
Version 0.01
=cut
-our $VERSION = '0.01_01';
+our $VERSION = '0.01_03';
=head1 SYNOPSIS
@@ -187,47 +187,17 @@ sub _exec_cmd {
Andre Santos, C<< <andrefs at cpan.org> >>
-=head1 BUGS
-
-Please report any bugs or feature requests to C<bug-app-texmine at rt.cpan.org>, or through
-the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=App-texmine>. I will be notified, and then you'll
-automatically be notified of progress on your bug as I make changes.
-
-
-
-
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
- perldoc App::texmine
-
-
-You can also look for information at:
-
-=over 4
-
-=item * RT: CPAN's request tracker (report bugs here)
-
-L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=App-texmine>
-
-=item * AnnoCPAN: Annotated CPAN documentation
-
-L<http://annocpan.org/dist/App-texmine>
-
-=item * CPAN Ratings
-
-L<http://cpanratings.perl.org/d/App-texmine>
-
-=item * Search CPAN
-
-L<http://search.cpan.org/dist/App-texmine/>
-
-=back
+ perldoc App::TeXMine
+=head1 DEVELOPMENT
-=head1 ACKNOWLEDGEMENTS
+=head2 Repository
+L<http://github.com/andrefs/app-texmine>
=head1 LICENSE AND COPYRIGHT
@@ -242,4 +212,4 @@ See http://dev.perl.org/licenses/ for more information.
=cut
-1; # End of App::texmine
+1; # End of App::TeXMine

0 comments on commit c9333f9

Please sign in to comment.