Open Chinese Convert  0.4.1
A project for conversion between Traditional and Simplified Chinese
 All Data Structures Files Functions Variables Groups Pages
/Data/dev/opencc/README.md
1 # Open Chinese Convert
2 
3 ## Introduction
4 
5 Open Chinese Convert (OpenCC, 開放中文轉換) is an opensource project for conversion between Traditional Chinese and Simplified Chinese, supporting character-level conversion, phrase-level conversion, variant conversion and regional idioms among Mainland China, Taiwan and Hong kong.
6 
7 中文簡繁轉換開源項目,支持詞彙級别的轉換、異體字轉換和地區習慣用詞轉換(中國大陸、臺灣、香港)。
8 
9 ## Documentations
10 
11 Project home page https://code.google.com/p/opencc/
12 
13 Introduction (詳細介紹) https://code.google.com/p/opencc/wiki/Introduction
14 
15 Development Documentation http://byvoid.github.io/OpenCC/
16 
17 Source Code on Github https://github.com/byvoid/opencc
18 
19 OpenCC Online (在線轉換) http://opencc.byvoid.com/
20 
21 ## Projects using Opencc
22 
23 * [ibus-pinyin](http://code.google.com/p/ibus/)
24 * [fcitx](http://code.google.com/p/fcitx/)
25 * [rimeime](http://code.google.com/p/rimeime/)
26 * [libgooglepinyin](http://code.google.com/p/libgooglepinyin/)
27 * [ibus-libpinyin](https://github.com/libpinyin/ibus-libpinyin)
28 
29 ## Installation
30 
31 ### Debian/Ubuntu
32 
33  apt-get install opencc
34 
35 ### Fedora
36 
37  yum install opencc
38 
39 ### Arch
40 
41  pacman -S opencc
42 
43 ### Mac OS
44 
45  brew install opencc
46 
47 ### Node.js
48 
49  npm install opencc
50 
51 ## Usage
52 
53  $ opencc --help
54 
55  Open Chinese Convert (OpenCC) Command Line Tool
56 
57  Author: BYVoid <byvoid@byvoid.com>
58  Bug Report: http://github.com/BYVoid/OpenCC/issues
59 
60  Usage:
61  opencc [Options]
62 
63  Options:
64  -i [file], --input=[file] Read original text from [file].
65  -o [file], --output=[file] Write converted text to [file].
66  -c [file], --config=[file] Load configuration of conversion from [file].
67  -v, --version Print version and build information.
68  -h, --help Print this help.
69 
70  With no input file, reads standard input and writes converted stream to standard output.
71  Default configuration(zhs2zht.ini) will be loaded if not set.
72 
73 ## Build
74 
75 ### Build with CMake
76 
77 Make a directory and check in:
78 
79  mkdir build
80  cd build
81 
82 Build sources:
83 
84  cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -D ENABLE_GETTEXT:BOOL=ON ..
85  make
86 
87 On windows, run these commands instead:
88 
89  cmake .. -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX="" -DCMAKE_BUILD_TYPE=Release -DENABLE_GETTEXT:BOOL=OFF
90  make
91 
92 Install:
93 
94  sudo make install
95 
96 
97 ### Build with gyp
98 
99  mkdir build
100  gyp --depth . -D library=shared_library -f make --generator-output=build opencc.gyp
101  make -C build
102 
103 ## Screenshoot
104 
105 ![OpenCC Mac](http://opencc.googlecode.com/files/screenshot-gui-mac.png)
106 
107 ![OpenCC Windows](http://opencc.googlecode.com/files/screenshot-gui.png)
108 
109 ![OpenCC Ubuntu](http://opencc.googlecode.com/files/screenshot-gui-ubuntu.png)