OSDN Git Service

Merge branch 'wdoor-stable'
[shogi-server/shogi-server.git] / README
1 = Shogi-server project
2
3 The Shogi-server project develops Shogi-server, a rating tool and so on.
4
5 == Shogi-server
6
7 Shogi-server is a server that implements the Server Protocol Ver 1.2.1 defined
8 by Computer Shogi Association (CSA[http://www.computer-shogi.org/index_e.html]) 
9 in order for computer shogi players to play games.   
10
11 === Pre-requires
12
13 Ruby 2.1 or later
14
15 For Debian,
16
17   $ sudo aptitude install ruby
18
19 === Install
20
21   $ git clone git://git.sourceforge.jp/gitroot/shogi-server/shogi-server.git
22
23 The following files are required to run Shogi-server:
24
25   - shogi-server
26   - shogi_server.rb
27   - shogi_server/**/*.rb
28
29 === Run
30
31 Examples:
32
33 Run the server with CSA Protocol V1.2 or later
34
35   $ ./shogi-server hoge 4000
36
37 With CSA Protocol V1.1.2 or before
38
39   $ ./shogi-server --max-moves 0 --least-time-per-move 1 hoge 4000
40
41 See others written in the 'shogi-server' file.
42
43 == Other tools
44
45 See documents at the head of each source file.
46
47 * mk_rate
48 * mk_html
49 * showgame
50
51
52 == Tests
53
54 Run the server
55
56   $ ./shogi-server hoge 4000
57
58 Run test cases
59
60   $ cd test
61   $ ruby TC_ALL.rb
62
63 Tested:
64
65 - ruby 2.0.0p481 (2014-05-08 revision 45883) [universal.x86_64-darwin13]
66   Finished in 55.025733 seconds.
67   383 tests, 1370 assertions, 0 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications
68   100% passed
69   6.96 tests/s, 24.90 assertions/s
70   ruby TC_ALL.rb  1.97s user 0.34s system 4% cpu 55.424 total
71   
72 ---
73 2015-01-17  Daigo Moriwaki <daigo at debian dot org>