From de25e592e228b383d521c0ec0031e560d73e7827 Mon Sep 17 00:00:00 2001 From: shima004 Date: Fri, 29 Nov 2024 13:15:22 +0900 Subject: [PATCH] docs: update installation instructions and directory structure in quickstart and install tutorials --- docs/source/quickstart/quickstart.md | 29 +++++++++++++------------ docs/source/tutorial/install/install.md | 6 ++--- 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/docs/source/quickstart/quickstart.md b/docs/source/quickstart/quickstart.md index 4142999..664dcd4 100644 --- a/docs/source/quickstart/quickstart.md +++ b/docs/source/quickstart/quickstart.md @@ -12,7 +12,7 @@ パッケージをインストールするには、次のコマンドを実行します: ```bash -pip install adf_core_python +pip install git+https://github.com/adf-python/adf-core-python.git ``` ## 新規エージェントの作成 @@ -34,21 +34,22 @@ 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 +└── my-agent + ├── config + │ ├── development.json + │ ├── launcher.yaml + │ └── module.yaml + ├── main.py + └── src + └── my-agent ├── __init__.py - └── complex + └── module ├── __init__.py - ├── sample_human_detector.py - ├── sample_road_detector.py - └── sample_search.py + └── complex + ├── __init__.py + ├── sample_human_detector.py + ├── sample_road_detector.py + └── sample_search.py ``` ## エージェントを実行する diff --git a/docs/source/tutorial/install/install.md b/docs/source/tutorial/install/install.md index c27a88f..032e22c 100644 --- a/docs/source/tutorial/install/install.md +++ b/docs/source/tutorial/install/install.md @@ -14,7 +14,7 @@ パッケージをインストールするには、次のコマンドを実行します: ```bash -pip install adf_core_python +pip install git+https://github.com/adf-python/adf-core-python.git ``` ## インストールの確認 @@ -22,7 +22,7 @@ pip install adf_core_python インストールを確認するには、次のコマンドを実行します: ```bash -python -c "import adf_core_python; print(adf_core_python.__version__)" +pip show adf_core_python ``` -パッケージが正しくインストールされている場合、パッケージのバージョン番号が表示されます。 +パッケージが正しくインストールされている場合、パッケージのバージョン番号などが表示されます。