READMEを更新

Author: ktabe

README.md

@@ -1,85 +1,30 @@
 # jlintpaper
 
-LaTeXで書かれた日本語の論文やレポートをチェックし，正しくない可能性がある箇所を指摘します．
+LaTeXで書かれた日本語の論文やレポートをチェックし，日本語的あるいはLaTeX的に正しくない可能性がある箇所を指摘します．
 間違った指摘があることに注意して下さい．
 
-主に卒論や修論のチェックに使うことを想定しています．
+主に理工系の卒論や修論のチェックに使うことを想定しています．
 
 ## 使い方
-コマンドラインから以下のように実行して下さい．
-ruby 2.0.0 以降が必要です．
+    Usage: ruby jlintpaper.rb [-m][-h][-d] files...
+    日本語のLaTeXのファイルに対して(いいかげんな)警告を出力します．
+    オプション:
+      -m: ANSI colorを使わない
+      -h: ヘルプ (この画面)
+      -d: デバッグ用
+    例:
+      ruby jlintpaper.rb foo.tex bar.tex
 
-> ruby jlintpaper.rb sample.tex
-
-\input は解釈しないのでご注意下さい．
+デフォルトではカラーで出力します．モノクロで出力する場合は -m オプションを付けて下さい．
 
 ## チェック項目
 60項目以上あります．
-どのようなチェック項目があるかは jlintpaper.rb を参照ください．
-
-# チェック結果の例
-```code:text
-=====================================================
- 間違った指摘をする可能性が十分あるので注意すること!
- checked by jlintpaper.rb 0.X.X
-=====================================================
-
-===半角(に対応する)がない===
-19:>>>(<<<マッチしないカッコ．
-
-===半角)に対応する(がない===
-21:>>>マッチしないカッコ)<<<．
-
-===`(左引用符)に対応する'(右引用符)がない===
-15:>>>`<<<`マッチしない引用符'．
-
-==='(右引用符)に対応する`(左引用符)がない===
-17:>>>`マッチしない引用符''<<<．
-
-===全角英数字は使わない===
-3: 2章では関連研究について述べ、>>>３<<<章で提案手法について述べる。
-
-===文末に句点やピリオドがない(?)===
-7: ときどき，全角文字の間に 空白が紛れ込んでいることがありません?>>><<<
-
-===不要な半角スペース(?)===
-7: ときどき，全角文字の間に>>> <<<空白が紛れ込んでいることがありません?
-
-===章や節，図表番号を直接指定している?(\refを使うべき)===
-3: >>>2章<<<では関連研究について述べ、３章で提案手法について述べる。
-
-===原則として平仮名で表記すべき語句(全て，出来，無い，時，通り，など) http://www.ieice.org/jpn/shiori/pdf/furoku_d.pdf===
-9: 完璧なチェックは>>>出来<<<ないけど，少しは役には立つと思います。
-
-===「です・ます」調は使わない．「だ・である」調を使う（謝辞の中は良い）．===
-9: 完璧なチェックは出来ないけど，少しは役には立つと思い>>>ます。<<<
-
-===口語表現「けど」→「が」===
-9: 完璧なチェックは出来ない>>>けど<<<，少しは役には立つと思います。
-
-===挙げられるの間違い(?)===
-13: 以下のような問題点が>>>上げられる<<<．
-
-===体言止め(?)===
-19: (マッチしないカッ>>>コ．<<<
-
-===文の終わり方がおかしい(?)===
-11: イタリックの代わりに数式モードで $xyz$ とか書いてないだろうか>>>．<<<
-15: ``マッチしない引用符'>>>．<<<
-17: `マッチしない引用符''>>>．<<<
-19: (マッチしないカッコ>>>．<<<
-
-===$log$のように書いた場合，l*o*gという意味．関数ならば\log，イタリックならば\textit{abc}を使うこと===
-11: >>>イタリックの代わりに数式モードで $xyz$<<< とか書いてないだろうか．
+どのようなチェック項目があるかは jlintpaper.rb を見て下さい．
 
-===句読点（。、）と全角のコンマやピリオド（．，）を混ぜて使わないこと===
-  # 全角ピリオドあるいはカンマを含む行数: 9
-  # 句読点を含む行数: 2
+特定のチェックを除くにはソースコード中の当該項目をコメントアウトして下さい．
 
-  ===句読点が使われている行===
-3: 2章では関連研究について述べ、３章で提案手法について述べる。
-9: 完璧なチェックは出来ないけど，少しは役には立つと思います。
-```
+## 出力例
+<img src="image/screenshot.png" width="720">
 
 ## 注意
 * \input は認識しません