Create README.md

README.md

@@ -1 +1,45 @@
-# JANTAMA
+# JantamaViewerについて
+
+このツールはじゃんたまの牌譜を解析して、４人麻雀の半荘（東風）のまとめを作成します。
+
+現在、実装されているのは以下の機能です。
+- 各局の結果表示（上がりまたは流局、点棒移動、立直、和了役）
+- 点棒状況のグラフ表示
+- 局毎の天鳳の牌譜エディタ用テキストへの変換
+- 牌譜の再生（牌譜ビューワー）
+- 放銃リスト
+- スタッツの表示
+
+## 使い方
+
+自身の環境に合わせて、Win または Macのzipファイルをダウンロードしてください。
+解凍した先のPaifuフォルダにじゃんたまの牌譜（**牌譜の入手については後述**）を入れてください。牌譜はJantamaViewerを起動後に追加しても構いません。
+牌譜追加後に解析ボタンを押すと、牌譜を解析して半荘（東風）のまとめを作成します。
+各局のまとめをクリックすると、天鳳の牌譜エディタ用テキストをクリップボードにコピーします。
+
+#### まとめに大会戦の名前を表示する
+Settings/contest_id.txtにIDと名前を追加することで大会戦の名前を表示します。
+
+#### ドロップダウンリストにプレイヤー名を登録する
+Settings/player_id.txtにIDと名前を追加することで検索用プレイヤー名を登録します。
+
+#### フォルダでフィルタリングを行う
+Paifuフォルダ以下にフォルダを作成します。例えば、次のような階層を作ります。
+ドロップダウンリストで[自分]を選択すると、[自分]フォルダ以下の牌譜がフィルタリングされます。
+
+Paifu
+  自分
+   8月
+   9月
+
+
+## 牌譜について
+
+牌譜のダウンロードはこちらのWikiをご覧ください。（作成者様に感謝します。ファイルの解析でもとても参考になりました）
+雀魂 API 解析にゃ！ Wiki*
+
+牌譜をファイルに保存するにゃ
+https://wikiwiki.jp/majsoul-api/%E7%89%8C%E8%AD%9C%E3%82%92%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AB%E4%BF%9D%E5%AD%98%E3%81%99%E3%82%8B%E3%81%AB%E3%82%83
+
+## プレビュー
+![スクリーンショット 2022-07-18 2 00 33](https://user-images.githubusercontent.com/108359839/179417467-12d4b5ec-e0e4-43a6-9c48-07dc46d21e80.png)