search

usdot-fhwa-stol / carma-platform

CARMA Platform is built on robot operating system (ROS) and utilizes open source software (OSS) that enables Cooperative Driving Automation (CDA) features to allow Automated Driving Systems to interact and cooperate with infrastructure and other vehicles through communication. Doxygen Source Code Documentation :
https://usdot-fhwa-stol.github.io/documentation/carma-platform/
402 stars 122 forks source link

Fix CARMA repo readme files to follow the same format #388

Closed maefromm closed 5 years ago

maefromm commented 5 years ago

Types of Issue

Descriptive summary

The following repos need the readme's updated to match the other repo format. https://github.com/usdot-fhwa-stol/autoware.ai (Different format) https://github.com/usdot-fhwa-stol/CARMANovatelGpsDriver (Different format) https://github.com/usdot-fhwa-stol/CARMAAvtVimbaDriver (No readme)

Expected behavior

Have same readme or landing page format across repos.

Software version this applies to

NA

Steps to reproduce the behavior

  1. Visit the sites above and make sure it follows the same layout as CARMAPlatform or others.

Related work

Link to related tickets or prior related work here. NA

msmcconnell commented 5 years ago

Those repos are all forks of 3rd party repos. It's worth considering whether we can add to them rather than replace them. The novatel readme for example serves as the primary documentation for that driver and needs to be preserved.

maefromm commented 5 years ago

@msmcconnell I think we can keep the content and just add the headers/content that we have for CARMA. Since we've forked it, I assume we can modify the content of the readme as needed.

msmcconnell commented 5 years ago

@maefromm Yeah I think that approach makes sense

TonysCousin commented 5 years ago

I will plan to add our template content to the front end of each of these. Good activity to nibble on today.

maefromm commented 5 years ago

Resolved with the following PRs.

Repo: CARMAAvtVimbaDriver PR Merge Notice: 16 from usdot-fhwa-stol/feature/StandardizeReadme

Repo: autoware.ai PR Merge Notice: 25 Feature/standardize readme

Repo: CARMANovatelGpsDriver PR Merge Notice: 32 from usdot-fhwa-stol/feature/StandardizeReadme