Update README.md

[h-wata]

Summary

README.mdの追記

• fix NAT超えする場合としない場合のスクリプトの使い分けについて説明する #6

Detail

Impact

Test

Attention

[github-actions]

Title

Update README.md

---

PR Type

documentation

---

Description

• rest_kachaka_api.pyとconnect_openrmf_by_zenoh.pyの使用方法をREADMEに追加
• config.yamlの設定方法とその例をREADMEに追加
• Open-RMFサーバーとの通信方法を詳細に記述

---

Changes walkthrough 📝

	Relevant files
Documentation	README.md スクリプト使用方法と設定の詳細をREADMEに追加                                                                README.md 追加されたスクリプトの使用方法を説明 config.yamlの設定方法を説明 Open-RMFサーバーとの通信方法を詳細に記述 +28/-0

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5]	1
🧪 Relevant tests	No
🔒 Security concerns	No
⚡ Key issues to review	None

[github-actions]

PR Code Suggestions ✨

Category	Suggestion	Score
Best practice	YAMLのインデントを2スペースに統一します。 config.yaml の例において、YAMLのインデントが正しくないと誤解される可能性があるため、インデントを2スペースに統一します。 README.md [122-125] +```yaml +method_mapping: + dock: return_home +``` - Suggestion importance[1-10]: 9 Why: Correcting the YAML indentation to a consistent 2-space format prevents potential misconfigurations and ensures clarity, which is crucial for proper script execution.	9
Enhancement	NAT traversal の意味を補足説明として追加します。 connect_openrmf_by_zenoh.py の説明において、「NAT traversal」が何を意味するのかを簡単に説明すると、ユーザーがより理解しやすくなります。例えば、「NAT traversal (ネットワークアドレス変換の通過)」のように補足説明を追加します。 README.md [31] -- Use this script when communicating with an Open-RMF server via Zenoh router, requiring NAT traversal. +- Use this script when communicating with an Open-RMF server via Zenoh router, requiring NAT traversal (ネットワークアドレス変換の通過). Suggestion importance[1-10]: 8 Why: Adding a brief explanation of "NAT traversal" makes the documentation more accessible to users who may not be familiar with the term, enhancing clarity and usability.	8
	スクリプトの使用例を追加します。 「## Usage of Scripts」セクションにおいて、スクリプトの使用例を追加すると、ユーザーが具体的な使い方を理解しやすくなります。 README.md [23-33] 1. `rest_kachaka_api.py`: ... +Example: +```bash +python rest_kachaka_api.py +``` 1. `connect_openrmf_by_zenoh.py`: +... +Example: +```bash +python connect_openrmf_by_zenoh.py +``` Suggestion importance[1-10]: 8 Why: Adding usage examples for the scripts provides clear guidance on how to run them, which is very helpful for users, especially those who are new to the project.	8
	スクリプトのファイル名をコードブロックで囲んで強調します。 rest_kachaka_api.py と connect_openrmf_by_zenoh.py の説明において、スクリプトのファイル名をコードブロックで囲むと、視覚的に強調されて読みやすくなります。 README.md [23-29] -1. rest_kachaka_api.py: +1. `rest_kachaka_api.py`: ... -1. connect_openrmf_by_zenoh.py: +1. `connect_openrmf_by_zenoh.py`: Suggestion importance[1-10]: 7 Why: Using code blocks to highlight script filenames improves readability and helps users quickly identify the scripts, enhancing the overall user experience.	7