README.md in shogi-ruby-0.0.5 vs README.md in shogi-ruby-0.0.6
- old
+ new
@@ -1,9 +1,17 @@
-# Shogi Library for Ruby [](http://travis-ci.org/myokoym/shogi-ruby)
+# Shogi Library by Pure Ruby [](http://travis-ci.org/myokoym/shogi-ruby)
-Ruby用の将棋ライブラリです。CSA形式に対応しています。
+Ruby用の将棋ライブラリです。
+## 特徴
+
+* Rubyのみで記述されています。
+ * デバッグが楽です。
+ * インストールが楽です。
+* CSA形式に対応しています。
+ * コンピュータ将棋協会が推奨する標準形式です。
+
## 用途
### 向いていること
* 将棋盤の簡単なコンソール表示
* GUIアプリケーションの内部状態の管理
@@ -41,10 +49,36 @@
Ruby 2.0.0 or later. (and 1.9.3)
## Usage
+### Introduction
+
+* 使う準備
+
+ require 'shogi'
+
+* 対局を管理するクラス
+
+ Shogi::Game
+
+* 盤面を管理するクラス
+
+ Shogi::Board
+
+* 局面の情報をCSA形式で取得するメソッド
+
+ Shogi::Game#to_csa
+ Shogi::Board#to_csa
+
+* 駒を動かすメソッド
+
+ Shogi::Game#move
+ Shogi::Board#move
+
+### Tutorial
+
require 'shogi'
board = Shogi::Board.new
puts board.to_csa
#=> P1-KY-KE-GI-KI-OU-KI-GI-KE-KY
@@ -141,11 +175,16 @@
-3334FU
+8822UM
-3122GI
+0055KA
- game.at(3).show_all
+ puts game.at(3).kifu
+ #=> +7776FU
+ -3334FU
+ +8822UM
+
+ game.at(3).show
#=> 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 * * * * * * * * *
@@ -154,12 +193,9 @@
P8 * * * * * * * +HI *
P9+KY+KE+GI+KI+OU+KI+GI+KE+KY
P+00KA
P-
-
- +7776FU
- -3334FU
- +8822UM
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)