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.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 1.9.3 or 1.8.7
  14
  15 As of January 2012, Shogi-server supports both Ruby 1.9.3 and 1.8.7. In
  16 future, however, it will only work with Ruby 1.9.x.  The Ruby community
  17 claimed that Ruby 1.8 had no future.  It is recommended that you soon
  18 upgrade to Ruby 1.9.3.
  19
  20 For Debian,
  21  $ sudo aptitude install ruby1.9.1
  22
  23 Note that the latest ruby1.9.1 package in Debian originates from Ruby 1.9.3.
  24 "1.9.1" in the package name is Ruby internal API version, not release version.
  25
  26 === Install
  27
  28  $ git clone git://git.sourceforge.jp/gitroot/shogi-server/shogi-server.git
  29
  30 The following files are required to run Shogi-server:
  31
  32 - shogi-server
  33 - shogi_server.rb
  34 - shogi_server/**/*.rb
  35
  36 === Run
  37
  38 Examples:
  39
  40  $ ./shogi-server hoge 4000
  41
  42  $ ruby1.8 ./shogi-server hoge 4000
  43
  44  $ ruby1.9.1 ./shogi-server --pid-file shogi-server.pid \
  45                             --daemon . \
  46                             --player-log-dir player-log-dir \
  47                             --floodgate-history floodgate_history.yaml \
  48                             floodgatetest 4000
  49
  50 == Other tools
  51
  52 See documents at the head of each source file.
  53
  54 * mk_rate
  55 * mk_html
  56 * showgame
  57
  58
  59 == Tests
  60
  61 Run the server
  62
  63   $ ./shogi-server hoge 4000
  64
  65 Run test cases
  66
  67   $ cd test
  68   $ ruby TC_ALL.rb
  69
  70 Tested:
  71
  72 - ruby 1.9.3p0 (2011-10-30 revision 33570) [x86_64-linux]
  73   Finished tests in 83.667928s, 4.2669 tests/s, 11.7249 assertions/s.
  74   357 tests, 981 assertions, 0 failures, 0 errors, 0 skips
  75
  76 - ruby 1.8.7 (2011-06-30 patchlevel 352) [x86_64-linux]
  77   Finished in 69.885457 seconds.
  78   357 tests, 977 assertions, 0 failures, 0 errors
  79
  80
  81 ---
  82 2012-01-07 Daigo Moriwaki <daigo at debian dot org>