Skip to content

Commit

Permalink
Organization profile first draft (#1)
Browse files Browse the repository at this point in the history
* Organization profile first draft

A first pass at an organization profile for the AWF

* Added brief description of each repository

Brief description of each repository was taken from an older version of the autoware repository's README, with some additional minor editing.

Signed-off-by: Lalith Vipulananthan <[email protected]>

* Apply suggestions from code review

Co-authored-by: Lalith Vipulananthan <[email protected]>

* Apply suggestions from code review

Batch applying suggestions

Co-authored-by: M. Fatih CΔ±rΔ±t <[email protected]>

* Updated top image

Changelist:
- Added a link to the Autoware Foundation homepage at the top where the AWF is first mentioned
- Minor formatting changes around the Contribution Guidelines section
- Moved the Autoware Foundation link to the Useful resources section and removed the Appendix section as it seemed redundant with just the one link there

* Updated repository overview

* Add Discord invite badge

Co-authored-by: M. Fatih CΔ±rΔ±t <[email protected]>

Co-authored-by: M. Fatih CΔ±rΔ±t <[email protected]>
  • Loading branch information
Lalith Vipulananthan and xmfcx authored Mar 23, 2022
1 parent 165372f commit 04544fe
Showing 1 changed file with 35 additions and 9 deletions.
44 changes: 35 additions & 9 deletions profile/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,38 @@
## Hi there πŸ‘‹
## Welcome to the Autoware Foundation! πŸ‘‹
![Autoware_RViz](https://user-images.githubusercontent.com/63835446/158918717-58d6deaf-93fb-47f9-891d-e242b02cba7b.png)

<!--
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.

**Here are some ideas to get you started:**
[![Discord](https://img.shields.io/discord/953808765935816715?label=Join%20Autoware%20Discord&style=for-the-badge)](https://discord.gg/Q94UsPvReQ)

πŸ™‹β€β™€οΈ A short introduction - what is your organization all about?
🌈 Contribution guidelines - how can the community get involved?
πŸ‘©β€πŸ’» Useful resources - where can the community find your docs? Is there anything else the community should know?
🍿 Fun facts - what does your team eat for breakfast?
πŸ§™ Remember, you can do mighty things with the power of [Markdown](https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
-->
### 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 documentation](https://autowarefoundation.github.io/autoware-documentation/main/) (also [open source](https://github.com/autowarefoundation/autoware-documentation)!)
- [Autoware Foundation homepage](https://www.autoware.org/)

0 comments on commit 04544fe

Please sign in to comment.