briandfoy / unicode-unihan

(Perl) Adjustments to Dan Kogai's Unicode::Unihan module
0 stars 1 forks source link
perl perl-module

=pod

=encoding utf8

=for HTML

=for HTML

=for HTML

=for HTML Coverage Status

=for HTML

=for HTML

=head1 The Unicode::Unihan module

This is the I for the L Perl module, which is provided for legacy support only. This module was authored by Dan Kogai but is now maintained in legacy mode by brian d foy. Let's say "legacy" one more time: "legacy".

If you'd like to maintain this legacy module, raise an issue asking to take it over.

=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/Unicode/Unihan.pm

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

% perldoc Unicode::Unihan

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

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 Unicode::Unihan
% cpanm Unicode::Unihan

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.

=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/unicode-unihan

=back

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

=over 4

=item * Lhttps://github.com/briandfoy/unicode-unihan/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, bdfoy@cpan.org

=cut