README
1 _ _ _ _
2 | | (_)_ __ __ _ _ _ __ _ _ _ | | / \ _ _
3 | | | | '_ \ / _` | | | |/ _` | (_|_) _ | |/ _ \ (_|_)
4 | |___| | | | | (_| | |_| | (_| | _ _ | |_| / ___ \ _ _
5 |_____|_|_| |_|\__, |\__,_|\__,_| (_|_) \___/_/ \_\ (_|_)
6 |___/
7 __ __ _ _
8 | \/ | ___ (_|_)
9 | |\/| |/ _ \| | |
10 | | | | (_) | | |
11 |_| |_|\___// |_|
12 |__/
13
14
15This is the README for Lingua::JA::Moji version 0.36.
16
17Lingua::JA::Moji is a "module" for the Perl computer programming language, a
18library of computer code to install on a computer. This document contains four
19sections:
20
211. About - what the module does
22
232. Documentation - how to learn more about the module
24
253. Installation - how to install this module on a computer
26
274. Help - what to do if you get stuck
28
29-----------------------------------------------------------------------------
30
311. ABOUT
32
33Lingua::JA::Moji - Handle many kinds of Japanese characters
34
35This module provides methods to convert different written forms of
36Japanese into one another. It enables conversion between romanized
37Japanese, hiragana, and katakana. It also includes a number of unusual
38encodings such as Japanese braille and morse code, as well as
39conversions between Japanese and Cyrillic and Hangul. It also handles
40conversion between the Chinese characters (kanji) used before and
41after the character reforms of 1949, as well as the various bracketed
42and circled forms of kana and kanji.
43
44All the functions in this module assume the use of Unicode
45encoding. All input and output strings must be encoded using Perl's
46"UTF-8" format.
47
48The module loads the various data format conversion files on demand,
49thus the various obscure conversions hopefully do not cause a memory
50burden.
51
52This module does not handle the conversion of kanji words into kana,
53or kana into kanji.
54
55-----------------------------------------------------------------------------
56
572. DOCUMENTATION
58
59You can read the documentation for the module online at the following websites:
60
61 * http://search.cpan.org/perldoc?Lingua::JA::Moji
62 * http://metacpan.org/release/Lingua-JA-Moji
63
64(These links go to the latest version of the module.)
65
66After installing the module, you can read the documentation on your computer
67using
68
69 perldoc Lingua::JA::Moji
70
71-----------------------------------------------------------------------------
72
733. INSTALLATION
74
75This module requires Perl version 5.8.9 or later.
76
77To install the module from CPAN, use
78
79 cpan Lingua::JA::Moji
80
81If you have the App::cpanminus installer, you may prefer
82
83 cpanm Lingua::JA::Moji
84
85To install the module from the source file, Lingua-JA-Moji-0.36.tar.gz, follow
86this sequence of commands:
87
88 tar xfz Lingua-JA-Moji-0.36.tar.gz
89 cd Lingua-JA-Moji-0.36
90 perl Makefile.PL
91 make
92 make install
93
94If you want to test the module before installing it, use "make test" after
95"make" and before "make install".
96
97-----------------------------------------------------------------------------
98
994. HELP
100
101To get help with the module, you can email the author, Ben Bullock, at
102bkb@cpan.org. If you think there is a problem in the module, you can report a
103bug at
104
105<https://github.com/benkasminbullock/Lingua-JA-Moji/issues>,
106
107or if you want to alter the source code of Lingua::JA::Moji, try the public
108repository on github at
109
110<https://github.com/benkasminbullock/Lingua-JA-Moji>.
111
112-----------------------------------------------------------------------------
113
114This README was written on Thu Feb 12 10:17:36 2015.
115
116-----------------------------------------------------------------------------
117