search

autowarefoundation / autoware.core

Apache License 2.0
43 stars 26 forks source link

docs: update README #36

Closed shmpwk closed 2 years ago

shmpwk commented 2 years ago

Signed-off-by: Shumpei Wakabayashi shumpei.wakabayashi@tier4.jp

Description

Update README with more concrete information. Related PR: https://github.com/autowarefoundation/autoware.universe/pull/970#issuecomment-1139188704

The README explanation is based on https://github.com/autowarefoundation/autoware which says

Main repository for high-quality, stable ROS packages for Autonomous Driving. Based on Autoware.Auto and Autoware.Universe.

I mainly changed the 2nd line because IMO

The universe explanation is based on https://github.com/autowarefoundation/autoware.

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

After all checkboxes are checked, anyone who has write access can merge the PR.

kenji-miyake commented 2 years ago

Is it okay if there is no explanation about the transition plan? I guess people would wonder why this repository is empty.

shmpwk commented 2 years ago

Right, add porting plan by 682af3d.

shmpwk commented 2 years ago

@BonoloAWF Thank you for your checking and I wrote the relationship btw core and universe here. https://github.com/autowarefoundation/autoware.core/pull/36/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R5-R11

shmpwk commented 2 years ago

@LalithVipulananthan @mitsudome-r @xmfcx @BonoloAWF

Could I merge this? If I can get one more approval, I'd like to merge this.

ghost commented 2 years ago

@shmpwk Apologies for missing this. I did want to rearrange some of the content in this README. If you can wait just a short while, I will review with my suggested changes before 5pm today.

shmpwk commented 2 years ago

Thank you! Could you merge this @kenji-miyake since I don't have right to merge this.