Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PyYoshi committed Sep 7, 2015
1 parent 3839487 commit 7caa7af
Showing 1 changed file with 6 additions and 11 deletions.
17 changes: 6 additions & 11 deletions README.markdown
@@ -1,5 +1,3 @@
<!-- markdown to rst: http://johnmacfarlane.net/pandoc/try -->

cChardet
========
cChardet is high speed universal character encoding detector. - binding to [charsetdetect](https://bitbucket.org/medoc/uchardet-enhanced/overview).
Expand Down Expand Up @@ -39,9 +37,9 @@ cChardet is high speed universal character encoding detector. - binding to [char

## Requires
* Cython: [http://www.cython.org/](http://www.cython.org/)

e.g.) Ubuntu 12.04

```bash
$ sudo apt-get install build-essential python-dev cython
```
Expand All @@ -53,13 +51,13 @@ $ cd /tmp
$ git clone git://github.com/PyYoshi/cChardet.git
$ cd cChardet
$ python setup.py build
$ sudo python setup.py install
$ python setup.py install
```

or

```bash
$ sudo easy_install cchardet
$ pip install -U cchardet
```

## Example
Expand All @@ -76,13 +74,13 @@ print(result)
## Test

```bash
$ sudo easy_install or pip install -U chardet nose
$ pip install -U chardet nose
$ cd test
$ nosetests --nocapture tests.py
```

## Benchmark
code: [tests.TestCchardetSpeed](https://github.com/PyYoshi/cChardet/blob/master/test/tests.py#L461)
code: [tests.TestCchardetSpeed](https://github.com/PyYoshi/cChardet/blob/master/test/tests.py#L468)

sample: [test/testdata/wikipediaJa_One_Thousand_and_One_Nights_SJIS.txt](https://github.com/PyYoshi/cChardet/blob/master/test/testdata/wikipediaJa_One_Thousand_and_One_Nights_SJIS.txt)

Expand Down Expand Up @@ -118,8 +116,5 @@ Platform: Kubuntu 12.04 amd64, Python 2.7.3 64-bit
* [Cython](http://www.cython.org/)

## Contact
[My blog](http://blog.remu.biz)

[Issues](https://github.com/PyYoshi/cChardet/issues?page=1&state=open)

Sorry for my poor English :)

0 comments on commit 7caa7af

Please sign in to comment.