gazebosim / gz-sensors

Provides numerous sensor models designed to generate realistic data from simulation environments.
https://gazebosim.org
Apache License 2.0
52 stars 53 forks source link

List all available sensors on the README #103

Open chapulina opened 3 years ago

chapulina commented 3 years ago

A new user landing at https://ignitionrobotics.org/libs/sensors should have a quick way to find out what sensors are supported.

Desired behavior

List all sensors on the README, with links to their APIs, like Altimeter.

Alternatives considered

The list could be somewhere else, but the README is probably the most evident place, both to users navigating to https://ignitionrobotics.org/libs/sensors and to https://github.com/ignitionrobotics/ign-sensors/.

Implementation suggestion

Use a markdown table or an unordered list.

benediktkreis commented 2 years ago

This would be indeed very helpful! Furthermore, I suggest that the README list includes one SDF implementation example and a list of all available tags with a hint if they are required or optional.

tejalbarnwal commented 1 year ago

Hey, could you please assign this to me?

iche033 commented 1 year ago

Hey, could you please assign this to me?

done, assigned.

tejalbarnwal commented 1 year ago

Hey, I was wondering whether I should mention the links for the API for each version of Gazebo Ignition Release? and creating a format as below

I apologise for asking such a silly question, but I am just getting started with open source contributions and would like to confirm it so that I do not make a mistake.

mjcarroll commented 1 year ago

@tejalbarnwal I think that is a great format. By available tags, do you mean pointing off to the corresponding sdformat documentation? eg http://sdformat.org/spec?ver=1.9&elem=sensor#sensor_altimeter for altimeter?

tejalbarnwal commented 1 year ago

I was actually planning to list all the tags individually. However now I think yeah, this is a better idea to point to the respective sdformat documentation.

aagrawal05 commented 3 months ago

Hi, is this issue still active? If so what is remaining to be done? The landing page appears to still not have the updated description. I'd be happy to help.