____ _ _ __ _ _
| _ \ __ _| |_ __ _ _ _ | |/ /__ _ _ __ (_|_) _ _
| | | |/ _` | __/ _` | (_|_) | ' // _` | '_ \ | | | (_|_)
| |_| | (_| | || (_| | _ _ | . \ (_| | | | || | | _ _
|____/ \__,_|\__\__,_| (_|_) |_|\_\__,_|_| |_|/ |_| (_|_)
|__/
_ __ _ _ _ _
| |/ /__ _ _ __ (_|_) __| (_) ___
| ' // _` | '_ \ | | |/ _` | |/ __|
| . \ (_| | | | || | | (_| | | (__
|_|\_\__,_|_| |_|/ |_|\__,_|_|\___|
|__/
This is the README for Data::Kanji::Kanjidic version 0.14.
Data::Kanji::Kanjidic is a "module" for the Perl computer programming language,
a library of computer code to install on a computer. This document contains
four sections:
1. About - what the module does
2. Documentation - how to learn more about the module
3. Installation - how to install this module on a computer
4. Help - what to do if you get stuck
-----------------------------------------------------------------------------
1. ABOUT
Data::Kanji::Kanjidic - parse the "kanjidic" kanji data file
This is a module for extracting the data from the old-format
"kanjidic" kanji dictionary file created by Professor Jim Breen.
This module's basic function is to read the "kanjidic" file into
memory and create a data structure from it. The user then uses this
data structure for whatever purpose. Parsing Kanjidic takes a second
or two. Here the Kanjidic file is the as-downloaded text file in the
old format, rather than the new-format XML file.
There are several examples of the module's use in the "examples"
directory of the distribution, including all the code in the module's
documentation.
-----------------------------------------------------------------------------
2. DOCUMENTATION
You can read the documentation for the module online at the following websites:
* http://search.cpan.org/perldoc?Data::Kanji::Kanjidic
* http://metacpan.org/release/Data-Kanji-Kanjidic
(These links go to the latest version of the module.)
After installing the module, you can read the documentation on your computer
using
perldoc Data::Kanji::Kanjidic
-----------------------------------------------------------------------------
3. INSTALLATION
This module requires Perl version 5.6.1 or later.
To install the module from CPAN, use
cpan Data::Kanji::Kanjidic
If you have the App::cpanminus installer, you may prefer
cpanm Data::Kanji::Kanjidic
To install the module from the source file, Data-Kanji-Kanjidic-0.14.tar.gz,
follow this sequence of commands:
tar xfz Data-Kanji-Kanjidic-0.14.tar.gz
cd Data-Kanji-Kanjidic-0.14
perl Makefile.PL
make
make install
If you want to test the module before installing it, use "make test" after
"make" and before "make install".
-----------------------------------------------------------------------------
4. HELP
To get help with the module, you can email the author, Ben Bullock, at
<bkb@cpan.org>. If you think there is a problem in the module, you can report a
bug at
<https://github.com/benkasminbullock/Data-Kanji-Kanjidic/issues>,
or if you want to alter the source code of Data::Kanji::Kanjidic, try the
public repository on github at
<https://github.com/benkasminbullock/Data-Kanji-Kanjidic>.
-----------------------------------------------------------------------------
This README was written on Mon Aug 18 07:51:34 2014.
-----------------------------------------------------------------------------