Skip to content

Commit 6b70d04

Browse files
committed
README update
1 parent 0cff32c commit 6b70d04

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@
44
# mecab-python3
55

66
This is a Python wrapper for the [MeCab][] morphological analyzer for Japanese
7-
text. It works with Python 3.5 and greater, as well as Python 2.7. (Note:
8-
Python 3.5 is not supported on OSX, see [this
9-
issue](https://github.com/SamuraiT/mecab-python3/issues/41)).
7+
text. It works with Python 3.5 and greater, as well as Python 2.7.
8+
9+
(Note: Python 3.5 is not supported on OSX, see [this issue][osx-issue]).
1010

1111
[MeCab]: https://taku910.github.io/mecab/
12+
[osx-issue]: https://github.com/SamuraiT/mecab-python3/issues/41
1213

13-
Note that Windows wheels require a [Microsoft Visual C++ Redistributable][msvc], so be sure to install that.
14+
Note that Windows wheels require a [Microsoft Visual C++
15+
Redistributable][msvc], so be sure to install that.
1416

1517
[msvc]: https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads
1618

@@ -32,24 +34,27 @@ EOS
3234
```
3335

3436
The API for `mecab-python3` closely follows the API for MeCab itself,
35-
even when this makes it not very “Pythonic.” Please consult the MeCab
36-
documentation for more information.
37+
even when this makes it not very “Pythonic.” Please consult the [official MeCab
38+
documentation][mecab-docs] for more information.
39+
40+
[mecab-docs]: https://taku910.github.io/mecab/
3741

3842
# Installation
3943

40-
Binary wheels are available for MacOS X and Linux, and are installed
41-
by default when you use `pip`:
44+
Binary wheels are available for MacOS X, Linux, and Windows (64bit) are
45+
installed by default when you use `pip`:
4246

4347
```sh
4448
pip install mecab-python3
4549
```
4650

47-
These wheels include an internal (statically linked) copy of the MeCab
48-
library, and a copy of the [`mecab-ipadic`][ipadic] dictionary (using
49-
UTF-8 text encoding), which is automatically used by default. If you
50-
wish to use a different dictionary, you will need to install it
51-
yourself, write a `mecabrc` file directing MeCab to use it, and set
52-
the environment variable `MECABRC` to point to this file.
51+
These wheels include an internal (statically linked) copy of the MeCab library,
52+
but not dictionary. In order to use MeCab you'll need to install a dictionary.
53+
`unidic-lite` is a good one to start with:
54+
55+
```sh
56+
pip install unidic-lite
57+
```
5358

5459
To build from source using pip,
5560

0 commit comments

Comments
 (0)