Skip to content
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.

Sign up for GitHub

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

Jump to bottom

update transport_drivers README to give an overview of all packages #49

Open
8 tasks
flynneva opened this issue Mar 25, 2021 · 1 comment
Open
8 tasks

update transport_drivers README to give an overview of all packages #49

flynneva opened this issue Mar 25, 2021 · 1 comment

Comments

@flynneva
Copy link
Contributor

Would be nice to update the README after the recent flurry of development. some quick things I'd like to see in it:

Each package:

  • one-liner purpose
  • published topics/subscribed topics
  • parameters
  • quick-start

Transport driver:

  • quick-start/how-to
  • supported distros/OS's
  • contributing instructions
  • CI overview
@flynneva
Copy link
Contributor Author

flynneva commented Mar 25, 2021 •
edited
Loading

to be clear I think that all of this should be just for the main README transport_drivers/README.md. we could add more README's within each sub-package as well with more in-depth information for each one there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@flynneva