OSDN Git Service

put a short description into README.ja.
[ocaml-nkf/ocaml-nkf.git] / README.ja
1 OCaml-nkf
2 =========
3
4 このソフトウェアは、Objective Caml 用の漢字コード変換モジュールです。
5 Ruby (http://www.ruby-lang.org) の NKF モジュールを移植したもので、
6 nkf (http://sourceforge.jp/projects/nkf/) を利用しています。
7
8
9 コンパイルとインストール
10 ------------------------
11
12 モジュールのコンパイルは以下のようにしてください。
13
14   $ make all
15
16 インストールには findlib を利用しています。
17
18   # make install
19
20
21 アンインストール
22 ----------------
23
24 インストールしたパッケージは次のようにアンインストールできます。
25
26   # make uninstall
27
28
29 使い方
30 ------
31
32   Nkf.nkf opt str
33
34 opt には、コマンドラインユーティリティ nkf に与えるのと同じコマンドライ
35 ンオプションを string で指定します。(ex. "-Sw")
36
37 str は変換したい string です。
38
39 結果は string で返ります。
40
41
42 ライセンス
43 ----------
44
45 ライセンスは Ruby のライセンスに従います。詳細は COPYING.ja を見てください。