deploy: 2fc0cc7

Author: shima004

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 28e90c62ef818bf83c80ac9e4d767757
+config: 30aa09aca0e077e710b099b3600e18b3
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/installation/installation.md

@@ -0,0 +1,29 @@
+# インストール
+
+このセクションでは、パッケージのインストール方法について説明します。
+
+
+## 前提条件
+
+インストールする前に、以下の前提条件を確認してください：
+
+- Python 3.12 以上
+- pip
+
+## パッケージのインストール
+
+パッケージをインストールするには、次のコマンドを実行します：
+
+```bash
+pip install adf_core_python
+```
+
+## インストールの確認
+
+インストールを確認するには、次のコマンドを実行します：
+
+```bash
+python -c "import adf_core_python; print(adf_core_python.__version__)"
+```
+
+パッケージが正しくインストールされている場合、パッケージのバージョン番号が表示されます。

_sources/installation/installation.rst

@@ -0,0 +1,62 @@
+# クイックスタート
+
+## 前提条件
+
+インストールする前に、以下の前提条件を確認してください：
+
+- Python 3.12 以上
+- pip
+
+## パッケージのインストール
+
+パッケージをインストールするには、次のコマンドを実行します：
+
+```bash
+pip install adf_core_python
+```
+
+## 新規エージェントの作成
+
+新規エージェントを作成するには、次のコマンドを実行します：
+
+```bash
+adf-core-python
+```
+
+実行すると、下記のような対話形式のプロンプトが表示されます：
+
+```bash
+Your agent team name: my-agent
+Creating a new agent team with name: my-agent
+```
+
+入力後、下記のようなエージェントのテンプレートがカレントディレクトリに作成されます。
+
+```bash
+.
+├── config
+│   ├── development.json
+│   ├── launcher.yaml
+│   └── module.yaml
+├── main.py
+└── src
+    └── my-agent
+        ├── __init__.py
+        └── module
+            ├── __init__.py
+            └── complex
+                ├── __init__.py
+                ├── sample_human_detector.py
+                ├── sample_road_detector.py
+                └── sample_search.py
+```
+
+## エージェントを実行する
+
+エージェントを実行するには、シミュレーションサーバーを起動し、次のコマンドを実行します：
+
+```bash
+python main.py
+```
+
+エージェントの実行が開始され、シミュレーションサーバーとの通信が開始されます。

_sources/quickstart/quickstart.md

@@ -0,0 +1,49 @@
+# エージェントの作成
+
+このセクションでは、`adf-core-python` ライブラリの使用方法の概要を提供します。
+
+## 新規エージェントの作成
+
+新規エージェントを作成するには、次のコマンドを実行します：
+
+```bash
+adf-core-python
+```
+
+実行すると、下記のような対話形式のプロンプトが表示されます：
+
+```bash
+Your agent team name: my-agent
+Creating a new agent team with name: my-agent
+```
+
+入力後、下記のようなエージェントのテンプレートがカレントディレクトリに作成されます。
+
+```bash
+.
+├── config
+│   ├── development.json
+│   ├── launcher.yaml
+│   └── module.yaml
+├── main.py
+└── src
+    └── my-agent
+        ├── __init__.py
+        └── module
+            ├── __init__.py
+            └── complex
+                ├── __init__.py
+                ├── sample_human_detector.py
+                ├── sample_road_detector.py
+                └── sample_search.py
+```
+
+## エージェントを実行する
+
+エージェントを実行するには、シミュレーションサーバーを起動し、次のコマンドを実行します：
+
+```bash
+python main.py
+```
+
+エージェントの実行が開始され、シミュレーションサーバーとの通信が開始されます。

_sources/quickstart/quickstart.rst

@@ -1,24 +1,20 @@
-コンフィグについて
-=================
+# コンフィグについて
 
-コンフィグについての説明
-----------------
+## コンフィグについての説明
+
+### launcher.yaml
 
-launcher.yaml
-^^^^^^^^^^^^^
 launcher.yaml は、エージェントの起動時に読み込まれる設定ファイルです。
 シミュレーションサーバーの指定や読み込むモジュールが記述されたファイルの指定などが記述されています。
 
+### module.yaml
 
-module.yaml
-^^^^^^^^^^^
 module.yaml は、エージェントが読み込むモジュールの設定ファイルです。
 読み込むモジュールのパスなどが記述されています。
 パスを指定する際は、プロジェクトのmain.pyからの相対パスで指定してください。
 
+### development.json
 
-development.json
-^^^^^^^^^^^^^^^^^
 development.json は、開発時に使用する設定ファイルです。
 エージェントの開発時に外部から値を取得する際に使用します。
 そのため、競技時には使用することができません。