Add README

[lorepieri8]

It would be good to have a README file for each demo that briefly explains what's inside.

[audrow]

I think this is a good idea.

[cardboardcode]

+1 from me as well. I should be available to take a look at this within the month of July 2022 if no one else is doing it.

@lorepieri8 @audrow

Will update accordingly here in this thread regarding progress.

[cardboardcode]

TODO

For each demo to have its own README.md, a total of 18 README.md will need to be created for the following folders.

Updated as of 24th Jan 2023:

• root README.md
• action_tutorials/action_tutorials_cpp
• action_tutorials/action_tutorials_interfaces/
• action_tutorials/action_tutorials_py
• demos/composition/
• demos/demo_nodes_cpp/
• demos/demo_nodes_cpp_native/
• demos/demo_nodes_py/
• dummy_robot/dummy_map_server/
• dummy_robot/dummy_robot_bringup/
• dummy_robot/dummy_sensors/
• demos/image_tools/
• demos/intra_process_demo/
• demos/lifecycle/
• demos/lifecycle_py/
• demos/logging_demo/
• demos/pendulum_control/
• demos/pendulum_msgs/
• demos/quality_of_service_demo/
• demos/topic_monitor/
• demos/topic_statistics_demo/

Author's Comment: as of 22nd July 2022

Rectified and tidied up the hyperlinks for each individual task for easier access.

[audrow]

+1 from me as well. I should be available to take a look at this within the month of July 2022 if no one else is doing it.

@lorepieri8 @audrow

Will update accordingly here in this thread regarding progress.

That'd be great - feel free to @ me for reviews!

[kagibson]

@cardboardcode What is the status with this? I would be happy to work on this or help

[cardboardcode]

@cardboardcode What is the status with this? I would be happy to work on this or help

Hi @kagibson, I have yet to get started. If you like, you can choose from the above list the tasks you wish to work on first. I would simply do the remaining.

Thanks for the offer of help 😊

[cardboardcode]

@kagibson

For now, I will get started doing the following tasks:

• dummy_robot/dummy_map_server/
• dummy_robot/dummy_robot_bringup/
• dummy_robot/dummy_sensors/
• demos/image_tools/

Will update in the task list once it is completed.

[cardboardcode]

Hi @audrow, may I get your assistance to review the following added README.mds ?

• image_tools - README.md
• dummy_map_server - README.md
• dummy_sensors - README.md
• dummy_robot_bringup - README.md

Thank you.

[kagibson]

@cardboardcode Thank you! I will work on the following:

• action_tutorials/action_tutorials_cpp/
• action_tutorials/action_tutorials_interfaces/
• action_tutorials/action_tutorials_py

[kagibson]

@audrow I'm in the process of writing the readme for the action_tutorials. So far I have an introduction on what is going on in the example. Do we want an in depth description of the code (what each callback is doing etc) or just an explanation of what the demo is doing and how to run it?

[cardboardcode]

@kagibson

Awaiting feedback from @audrow on aforementioned completed README.mds.

Will be starting work on the following new tasks:

• demos/intra_process_demo
• demos/pendulum_msgs
• demos/logging_demo

[audrow]

@audrow I'm in the process of writing the readme for the action_tutorials. So far I have an introduction on what is going on in the example. Do we want an in depth description of the code (what each callback is doing etc) or just an explanation of what the demo is doing and how to run it?

@kagibson, I would think that a high level description would be enough, maybe referring to blocks of code and explaining what they're doing. That being said, if you find anything surprising or unintuitive, that's probably a good spot to go into more detail.