-
Notifications
You must be signed in to change notification settings - Fork 34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update readme #82
Update readme #82
Conversation
During this update, I noticed, the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for helping improve documentation
Mainly this package has been a |
Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Force-pushed fixes for commit sign-offs... |
https://github.com/Mergifyio backport humble |
✅ Backports have been created
|
https://github.com/Mergifyio backport iron |
✅ Backports have been created
|
* Readme: add overview of components Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Update wiki.ros.org URL to https Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: specify shell language for commands Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Consistent punctuation Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Update parameter description Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Clearify mux initial_topic param Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> --------- Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> Co-authored-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> (cherry picked from commit f73df4a)
* Readme: add overview of components Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Update wiki.ros.org URL to https Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: specify shell language for commands Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Consistent punctuation Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Update parameter description Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Clearify mux initial_topic param Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> --------- Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> Co-authored-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> (cherry picked from commit f73df4a)
* Readme: add overview of components Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Update wiki.ros.org URL to https Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: specify shell language for commands Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Consistent punctuation Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Update parameter description Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Clearify mux initial_topic param Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> --------- Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> Co-authored-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> (cherry picked from commit f73df4a) Co-authored-by: Jan Gutsche <34797331+jaagut@users.noreply.github.com>
* Readme: add overview of components Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Update wiki.ros.org URL to https Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: specify shell language for commands Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Consistent punctuation Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Update parameter description Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> * Readme: Clearify mux initial_topic param Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> --------- Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> Co-authored-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de> (cherry picked from commit f73df4a) Co-authored-by: Jan Gutsche <34797331+jaagut@users.noreply.github.com>
This PR contains few updates to the
README.md
file.The most relevant changes are updates to the parameter descriptions, mainly of
Throttle
andDelay
. They seemed to be outdated.Additionally, a list of all components including clickable references to the detailed sections and a short description has been introduced.
Other minor changes are:
wiki.ros.org
URL to https, previously httpshell
for commands, as recommended for Markdown