README.md in shogi-ruby-0.0.2 vs README.md in shogi-ruby-0.0.3
- old
+ new
@@ -1,7 +1,30 @@
# Shogi Library for Ruby [](http://travis-ci.org/myokoym/shogi-ruby)
+Ruby用の将棋ライブラリです。
+
+## 用途
+### 向いていること
+* 将棋盤の簡単なコンソール表示
+* GUIアプリケーションの内部状態の管理
+
+### 向いていないこと
+* 速度的に、思考エンジンのデータ構造には向きません。
+
+## 機能
+### できること
+* CSA形式で、将棋盤オブジェクトを作成、操作、表示できます。
+* 駒の動きが正しいかどうかチェックできます。
+
+### まだできないこと
+* 二歩チェック
+* 行きどころのない駒のチェック
+* 詰みチェック
+* 手番の管理
+* 棋譜の管理
+* USI形式との相互変換
+
## Installation
Add this line to your application's Gemfile:
gem 'shogi-ruby'
@@ -34,11 +57,11 @@
P8 * +KA * * * * * +HI *
P9+KY+KE+GI+KI+OU+KI+GI+KE+KY
P+
P-
- board.move_from_csa("+7776FU")
+ board.move("+7776FU", :csa)
puts board.to_csa
#=> P1-KY-KE-GI-KI-OU-KI-GI-KE-KY
P2 * -HI * * * * * -KA *
P3-FU-FU-FU-FU-FU-FU-FU-FU-FU
P4 * * * * * * * * *
@@ -48,13 +71,13 @@
P8 * +KA * * * * * +HI *
P9+KY+KE+GI+KI+OU+KI+GI+KE+KY
P+
P-
- board.move_from_csa("-3334FU")
- board.move_from_csa("+8822UM")
- board.to_csa
+ board.move("-3334FU", :csa)
+ board.move("+8822UM", :csa)
+ puts board.to_csa
#=> P1-KY-KE-GI-KI-OU-KI-GI-KE-KY
P2 * -HI * * * * * +UM *
P3-FU-FU-FU-FU-FU-FU * -FU-FU
P4 * * * * * * -FU * *
P5 * * * * * * * * *
@@ -63,12 +86,13 @@
P8 * * * * * * * +HI *
P9+KY+KE+GI+KI+OU+KI+GI+KE+KY
P+00KA
P-
- board.move_from_csa("-3122GI")
- board.move_from_csa("+0055KA")
- board.to_csa
+ board.default_format = :csa
+ board.move("-3122GI")
+ board.move("+0055KA")
+ board.show
#=> P1-KY-KE-GI-KI-OU-KI * -KE-KY
P2 * -HI * * * * * -GI *
P3-FU-FU-FU-FU-FU-FU * -FU-FU
P4 * * * * * * -FU * *
P5 * * * * +KA * * * *