Skip to content

Commit 2c0aa0a

Browse files
authored
Merge pull request #15 from chezou/revert-md
Use markdown for README again
2 parents 3b2ad6c + 28517d2 commit 2c0aa0a

File tree

6 files changed

+51
-50
lines changed

6 files changed

+51
-50
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
*~
88
\#*#
99
.#*
10+
.venv
11+
venv
1012
MANIFEST
1113
MeCab.py
1214
MeCab_wrap.c*

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
include *.rst *.html
1+
include *.md *.html
22
include AUTHORS BSD GPL LGPL COPYING
33
include test.py
44
include MANIFEST.in

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
[![Build Status](https://travis-ci.org/SamuraiT/mecab-python3.svg?branch=master)](https://travis-ci.org/SamuraiT/mecab-python3)
2+
3+
mecab-python3
4+
-------------
5+
6+
This python wrapper for mecab works on both **python3.x** and **python2.x**.
7+
8+
9+
Installation and Usage
10+
--------------
11+
12+
```sh
13+
pip install mecab-python3
14+
```
15+
16+
You must have `mecab` and `swig` installed before running `setup.py`.
17+
For instance, on Debian-based Linux,
18+
19+
```sh
20+
sudo apt-get install mecab mecab-ipadic-utf8 libmecab-dev swig
21+
```
22+
23+
2. How to use?
24+
25+
see 'test.py' as a sample program.
26+
27+
3. Simple example
28+
29+
```py
30+
import MeCab
31+
mecab = MeCab.Tagger ("-Ochasen")
32+
print(mecab.parse("pythonが大好きです"))
33+
```
34+
35+
36+
License
37+
-------
38+
MeCab is copyrighted free software by Taku Kudo <[email protected]> and
39+
Nippon Telegraph and Telephone Corporation, and is released under
40+
any of the GPL (see the file GPL), the LGPL (see the file LGPL), or the
41+
BSD License (see the file BSD).

README.rst

Lines changed: 0 additions & 42 deletions
This file was deleted.

debian/docs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
README.rst
1+
README.md
22
bindings.html

setup.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
import os
44

55
try:
6-
import setuptools
6+
from setuptools import setup, Extension
7+
from setuptools.command.build_py import build_py as _build_py
78
except ImportError:
8-
pass
9-
10-
from distutils.core import setup, Extension
11-
from distutils.command.build_py import build_py as _build_py
9+
from distutils.core import setup, Extension
10+
from distutils.command.build_py import build_py as _build_py
1211

1312
# Distutils runs build_py and then build_ext, but MeCab.py won't exist
1413
# until build_ext runs, so subclass build_py to invoke build_ext itself.
@@ -41,7 +40,8 @@ def mecab_config(arg):
4140
setup(name = "mecab-python3",
4241
version = '0.8.3',
4342
description = 'python wrapper for mecab: Morphological Analysis engine',
44-
long_description = read_file('README.rst'),
43+
long_description = read_file('README.md'),
44+
long_description_content_type = 'text/markdown',
4545
maintainer = 'Tatsuro Yasukawa',
4646
maintainer_email = '[email protected]',
4747
url = 'https://github.com/SamuraiT/mecab-python3',

0 commit comments

Comments
 (0)