briandfoy / dumbbench

More reliable benchmarking without thinking
https://metacpan.org/pod/Dumbbench
Other
5 stars 4 forks source link
perl perl-module

=pod

=encoding utf8

=for HTML

=for HTML

=for HTML

=for HTML

=for HTML Coverage Status

=for HTML

=for HTML

=head1 The Dumbbench module

This is the I for the L Perl module. You're probably looking at this because you don't know where else to find what you're looking for. Read this once and you might never have to read one again for any Perl module.

=head2 Documentation

To read about L, look at the embedded documentation in the module itself. Inside the distribution, you can format it with L<perldoc|https://perldoc.perl.org/perldoc.html>:

% perldoc lib/Dumbbench.pm

If you have already installed the module, you can specify the module name instead of the file location:

% perldoc Dumbbench

You can read the documentation and inspect the meta data on L<MetaCPAN|https://metacpan.org/pod/Dumbbench>.

The standard module documentation has example uses in the SYNOPSIS section, but you can also look in the I directory (if it's there), or look at the test files in I.

=head2 Installation

You can install this module with a CPAN client, which will resolve and install the dependencies:

% cpan Dumbbench
% cpanm Dumbbench

You can also install directly from the distribution directory, which will also install the dependencies:

% cpan .
% cpanm .

You could install just this module manually:

% perl Makefile.PL
% make
% make test
% make install

You probably don't want to do that unless you're fiddling with the module and only want to run the tests without installing anything.

=head3 Dumbbench::BoxPlot install

If you want to use L (check it's Pod for details), you will need to add more software than is initially required to just run Dumbbench.

First, you need to provide development headers for the L<ROOT|https://root.cern.ch> application. How to install depends on your operational system requirements. For Ubuntu 16.04, installing the following packages will do:

sudo apt-get install libroot-gui-dev libroot-graf3d-g3d-dev libroot-graf3d-gl-dev libroot-graf2d-postscript-dev libroot-math-physics-dev

After that, you will need to install the L distribution, which provides a Perl binding for L<ROOT|https://root.cern.ch>. Once you have the required development headers and libraries, you just need to repeate the same steps already described for installing Dumbbench:

% cpanm SOOT

=head2 Source location

The meta data, such as the source repository and bug tracker, is in I or the I<META.*> files it creates. You can find that on those CPAN web interfaces, but you can also look at files directly in the source repository:

=over 4

=item * Lhttps://github.com/briandfoy/dumbbench

=back

If you find a problem, file a ticket in the L<issue tracker|https://github.com/briandfoy/dumbbench/issues>:

=over 4

=item * Lhttps://github.com/briandfoy/dumbbench/issues

=back

=head2 Getting help

Although I'm happy to hear from module users in private email, that's the best way for me to forget to do something.

Besides the issue trackers, you can find help at L<Perlmonks|http://www.perlmonks.org> or L<Stackoverflow|http://www.stackoverflow.com>, both of which have many competent Perlers who can answer your question, almost in real time. They might not know the particulars of this module, but they can help you diagnose your problem.

You might like to read L<brian's Guide to Solving Any Perl Problem|https://briandfoy.github.io/brians-guide-to-solving-any-perl-problem/>.

=head2 Copyright and License

You should have received a I file, but the license is also noted in the module files. About the only thing you can't do is pretend that you wrote code that you didn't.

=head2 Good luck!

Enjoy,

brian d foy, briandfoy@pobox.com Steffen Mueller, smueller@cpan.org

=cut