READMEのフォーマット修正 #86
Open
READMEのフォーマット修正 #86
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit e009e43.
YusukeKato
requested changes
Aug 6, 2025
Co-authored-by: YusukeKato <[email protected]>
Co-authored-by: YusukeKato <[email protected]>
|
@YusukeKato |
YusukeKato
requested changes
Aug 8, 2025
Co-authored-by: YusukeKato <[email protected]>
Kuwamai
requested changes
Aug 19, 2025
README.en.md
Outdated
Comment on lines
90
to
94
| - raspimouse_gazebo | ||
| - [Joystick Control](./raspimouse_gazebo/README.md#joystick-control) | ||
| - [Object Tracking](./raspimouse_gazebo/README.md#object-tracking) | ||
| - [Camera Line Follower](./raspimouse_gazebo/README.md#camera_line_follower) | ||
| - [SLAM & Navigation](./raspimouse_gazebo/README.md#slam--navigation) |
There was a problem hiding this comment.
今後のメンテナンス時に変更箇所が増えてしまうので、ここは削除してREADMEの案内のみでお願いしたいです。
There was a problem hiding this comment.
こちらについて一点意見があります。
リポジトリトップのREADMEを見た際に、どのような名前のサンプルが用意されているか把握できる形式としたほうが個人的にはわかりやすいと思います。ですので、各種サンプルに対してのリンクは削除して一覧を残すという方針はいかがでしょうか。
一度以下のような形式にしてみました。（箇条書きトップのraspimouse_gazeboの記述も、自明なので削除しています）
How to Use Examples
Detailed usage of the sample program is explained in the README of the raspimouse_gazebo package.
- Joystick Control
- Object Tracking
- Camera Line Follower
- SLAM & Navigation
README.md
Outdated
Comment on lines
90
to
94
| - raspimouse_gazebo | ||
| - [Joystick Control](./raspimouse_gazebo/README.md#joystick-control) | ||
| - [Object Tracking](./raspimouse_gazebo/README.md#object-tracking) | ||
| - [Camera Line Follower](./raspimouse_gazebo/README.md#camera_line_follower) | ||
| - [SLAM & Navigation](./raspimouse_gazebo/README.md#slam--navigation) |
There was a problem hiding this comment.
上記のREADME.en.mdと同じ意見です。
| ```sh | ||
| ros2 launch raspimouse_ros2_examples teleop_joy.launch.py joydev:="/dev/input/js0" joyconfig:=f710 mouse:=false | ||
| ``` | ||
|
|
Co-authored-by: Kuwamai <[email protected]>
|
@Kuwamai レビュー修正とコメントをしました。ご確認をお願いします。 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this implement/fix?
READMEのフォーマットを修正し、可読性をあげます。
Does this close any currently open issues?
しません。
How has this been tested?
テストはしていません。ドキュメントの整備のみです。
Any other comments?
英語と日本語のREADME両方が対象です。
現在のデフォルトであるros2ブランチと、README整備用のfix/readmeブランチのREADMEを直接見ると比較しやすいと思います
Checklists