forked from autowarefoundation/autoware_launch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: update readme (autowarefoundation#151)
* feat: update readme * ci(pre-commit): autofix * Update README.md Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com> * remove duplicated link Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com>
- Loading branch information
3 people
committed
Apr 5, 2022
1 parent
3463901
commit 26975da
Showing
1 changed file
with
42 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,45 @@ | ||
| # autoware | ||
| ## Welcome to Autoware! 👋 | ||
|
|
||
| A meta-repository for Autoware Core/Universe. | ||
|  | ||
|
|
||
| The [Autoware Foundation](https://www.autoware.org/) manages the development of Autoware, the world's leading open-source software project for autonomous driving, and sponsors Autoware-based projects all over the world. Autoware was started in 2015 and is being used by over 100 companies on more than 30 vehicles in over 20 different countries worldwide. | ||
|
|
||
| [](https://discord.gg/Q94UsPvReQ) | ||
|
|
||
| ### Documentation | ||
|
|
||
| See the [documentation site](https://autowarefoundation.github.io/autoware-documentation/main/) for details. | ||
|
|
||
| ### Repository overview | ||
|
|
||
| - [autowarefoundation/autoware](https://github.com/autowarefoundation/autoware) | ||
| - Meta-repository containing `.repos` files to construct an Autoware workspace. | ||
| - It is anticipated that this repository will be frequently forked by users, and so it contains minimal information to avoid unnecessary differences. | ||
| - [autowarefoundation/autoware_common](https://github.com/autowarefoundation/autoware_common) | ||
| - Library/utility type repository containing commonly referenced ROS packages. | ||
| - These packages were moved to a separate repository in order to reduce CI execution time | ||
| - [autowarefoundation/autoware.core](https://github.com/autowarefoundation/autoware.core) | ||
| - Main repository for high-quality, stable ROS packages for Autonomous Driving. | ||
| - Based on [Autoware.Auto](https://gitlab.com/autowarefoundation/autoware.auto/AutowareAuto) and [Autoware.Universe](https://github.com/autowarefoundation/autoware.universe). | ||
| - [autowarefoundation/autoware.universe](https://github.com/autowarefoundation/autoware.universe) | ||
| - Repository for experimental, cutting-edge ROS packages for Autonomous Driving. | ||
| - Autoware Universe was created to make it easier for researchers and developers to extend the functionality of Autoware Core | ||
| - [autowarefoundation/autoware_launch](https://github.com/autowarefoundation/autoware_launch) | ||
| - Launch configuration repository containing node configurations and their parameters. | ||
| - [autowarefoundation/autoware-github-actions](https://github.com/autowarefoundation/autoware-github-actions) | ||
| - Contains [reusable GitHub Actions workflows](https://docs.github.com/ja/actions/learn-github-actions/reusing-workflows) used by multiple repositories for CI. | ||
| - Utilizes the [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself) concept. | ||
| - [autowarefoundation/autoware-documentation](https://github.com/autowarefoundation/autoware-documentation) | ||
| - Documentation repository for Autoware users and developers. | ||
| - Since Autoware Core/Universe has multiple repositories, a central documentation repository is important to make information accessible from a single place. | ||
|
|
||
| ### Contribution guidelines | ||
|
|
||
| - [There is no formal process to become a contributor](https://github.com/autowarefoundation/autoware-projects/wiki#contributors) - you can comment on any [existing issues](https://github.com/autowarefoundation/autoware.universe/issues) or make a pull request on any Autoware repository! | ||
| - Make sure to follow the [Contribution Guidelines](https://autowarefoundation.github.io/autoware-documentation/main/contributing/). | ||
| - Take a look at Autoware's [various working groups](https://github.com/autowarefoundation/autoware-projects/wiki#working-group-list) to gain an understanding of any work in progress and to see how projects are managed. | ||
| - If you have any questions or ideas, feel free to start a discussion on [GitHub Discussions in autowarefoundation/autoware](https://github.com/autowarefoundation/autoware/discussions). | ||
|
|
||
| ### Useful resources | ||
|
|
||
| - [Autoware Foundation homepage](https://www.autoware.org/) |