ドキュメント

開発環境の準備

サンプルチームを実行するまでの手順を解説します.

必要なプログラム,ライブラリ,ツール

  • gcc
    librcscではC++テンプレートを多用しています. 後述のBoostを正しく導入,利用するためにもなるべく標準準拠度の高いコンパイラを使用してください.gcc以外のコンパイラ,gcc-3.0以前のバージョンを使用する場合,動作の保証ができません. Linuxであれば,ディストリビューションの公式パッケージに含まれているはずです.
  • GNU Autotools
    Autoconf, Automake, Libtoolを必要とします. 所謂 ``configure'' を利用するためのツールです. Autoconf,Automake,Libtoolを組み合わせて使用し,プログラムをコンパイルするための環境のチェックや設定を自動化してくれます. Linuxであれば,ディストリビューションの公式パッケージに含まれているはずです.
  • Boost 1.32 以降
    準標準と言われるC++テンプレートライブラリです. 最近のLinuxであれば,ディストリビューションの公式パッケージが用意されているはずです.
  • Qt 4.3 以降
    soccerwindow2を使用するために必須のライブラリです. soccerwindow2を使用しないのであれば必要ありませんが,導入を強く推奨します.
  • Doxygen
    プログラムソースファイル中のコメント文からドキュメントを自動生成してくれるツールです. 必須ではありませんが,librcscのリファレンスマニュアルを生成するために必要になります.

使用するプログラム

  • librcsc
    サッカーシミュレーションのチームプログラムやツールプログラムの開発に使用する基本ライブラリです. 以下の2つのプログラムで使用します.
  • soccerwindow2
    rcssmonitor互換のモニタプログラムです. 単体でログプレイヤとして動作するだけでなく,高機能なビジュアルデバッガとしても使用できます. チーム開発が本格的になってくれば必ず使用しましょう. このツールを使わなければ,強いチームを作ることは不可能です.
  • agent2d
    チームとして最小限動く状態にまとめたプログラムソースパッケージです. チーム開発を開始する際のテンプレートとして使用します. チーム開発時にはこのパッケージ内のソースを編集します.

コンパイル,インストール,アンインストール,実行方法

librcsc, soccerwindow2, agent2dの各ページに手順が記述されているので,そちらを参照してください.

Doxygenによるリファレンス生成

librcscのソースファイルにはDoxygen形式でのコメントがつけられています. librcscのパッケージディレクトリにDoxyfileというファイルが存在することを確認してください. 存在しない場合(Doxyfile.inというファイルのみ存在する場合)は,一度configureを実行してください. 確認できたらmake docを実行します(または,doxygenコマンドでも可).

$ cd librcsc-x.x.x/
$ make doc
...
Generating file index...
Generating directory index...
Generating example index...
Generating file member index...
$ ls doc
html

docというディレクトリが作られ,doc/html以下にhtmlのドキュメントが生成されます. doc/html/index.htmlがトップページです. まずは,「クラス」→「クラス階層」で階層関係を参照するのが分かりやすいかもしれません. Doxygenファイルを編集して好みの出力に設定変更することが出来ます.ただし,configureを実行するとDoxyfileが再生成され,編集内容が消えてしまうので,注意してください.


トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2016-03-14 (月) 14:51:37 (2049d)
SourceForge.JP
Creative Commons License
RoboCup tools by Hidehisa Akiyama is licensed under a Creative Commons 表示-非営利 2.1 日本 License.