refactor README.md #2668
refactor README.md #2668
Conversation
SamerKhshiboun
force-pushed
the
readme_fix
branch
8 times, most recently
from
8eb7397
to
ea1e4dd
Compare
… this to relative files
SamerKhshiboun
force-pushed
the
readme_fix
branch
from
ea1e4dd
to
e130f9f
Compare
README.md
Outdated
| [![humble][humble-badge]][humble] | ||
| [![foxy][foxy-badge]][foxy] | ||
| [![galactic][galactic-badge]][galactic] | ||
| [![eloquent][eloquent-badge]][eloquent] |
There was a problem hiding this comment.
Lets remove dashing and eloquent, also ubuntu 18
| * [Metadata Topic](#metadata) | ||
| * [Post-Processing Filters](#filters) | ||
| * [Available Services](#services) | ||
| * [Efficient intra-process communication](#intra-process) |
There was a problem hiding this comment.
We can here add some coordination system section/point to doc.
Better to explain in the doc Vision sensors + IMU axis
README.md
Outdated
| - [ROS2 Foxy](https://docs.ros.org/en/foxy/Installation/Ubuntu-Install-Debians.html) | ||
| - [ROS2 Galactic](https://docs.ros.org/en/galactic/Installation/Ubuntu-Install-Debians.html) | ||
| - #### Ubuntu 18.04 : | ||
| - [ROS2 Dashing](https://docs.ros.org/en/dashing/Installation/Ubuntu-Install-Debians.html) |
SamerKhshiboun
force-pushed
the
readme_fix
branch
from
01f23fb
to
f4dcecd
Compare
SamerKhshiboun
force-pushed
the
readme_fix
branch
8 times, most recently
from
9978f4e
to
06270e9
Compare
SamerKhshiboun
force-pushed
the
readme_fix
branch
from
06270e9
to
42fb45a
Compare
README.md
Outdated
| - [ROS2 Humble](https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html) | ||
| - #### Ubuntu 20.04: | ||
| - [ROS2 Foxy](https://docs.ros.org/en/foxy/Installation/Ubuntu-Install-Debians.html) | ||
| - [ROS2 Galactic](https://docs.ros.org/en/galactic/Installation/Ubuntu-Install-Debians.html) |
There was a problem hiding this comment.
Let's add a deprecated notice on it (galactic)
|
|
||
| ### Start the camera node | ||
| To start the camera node in ROS: | ||
| #### Parameters that can be modified during runtime: |
There was a problem hiding this comment.
Maybe we can use the "collapse" method more?
this section takes many lines and nor sure everyone needs it.
We can ether collapse or point to another doc if it's very big.
Same for the new CS chapter.
What do you think?
There was a problem hiding this comment.
we can use the collapse as much as we want.
The main reason I don't want to split it to another docs, is the keep it simple for searching.
Most of users search with CTRL+F, so it is easier to keep everything in one document.
What do you think ?
There was a problem hiding this comment.
Sure NP.
Does CTRL + F works inside "details"?
There was a problem hiding this comment.
As I tested it now, NO :)
README.md
Outdated
| [humble-badge]: https://img.shields.io/badge/-HUMBLE-orange?style=flat-square&logo=ros | ||
| [humble]: https://docs.ros.org/en/rolling/Releases/Release-Humble-Hawksbill.html | ||
| [foxy-badge]: https://img.shields.io/badge/-FOXY-orange?style=flat-square&logo=ros | ||
| [foxy]: https://docs.ros.org/en/rolling/Releases/Release-Foxy-Fitzroy.html |
Tracked by [LRS-676]