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.

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

docs(readme): add japanese documents #1638

Open
wants to merge 4 commits into
base: tier4/main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 76 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,94 @@
# Autoware Universe

## Welcome to Autoware Universe
## Autoware Universe へようこそ

Autoware Universe serves as a foundational pillar within the Autoware ecosystem, playing a critical role in enhancing the core functionalities of autonomous driving technologies.
This repository is a pivotal element of the Autoware Core/Universe concept, managing a wide array of packages that significantly extend the capabilities of autonomous vehicles.
Autoware Universe は自動運転技術の中核機能を強化において重要な役割を果たし、Autoware エコシステムの基盤を担っています。
このリポジトリは Autoware Core/Universe のコンセプトの中心的な要素であり、自動運転車両の機能を大幅に拡張する幅広いパッケージを管理しています。

![autoware_universe_front](docs/assets/images/autoware_universe_front.png)

## Getting Started
## はじめに

To dive into the vast world of Autoware and understand how Autoware Universe fits into the bigger picture, we recommend starting with the [Autoware Documentation](https://autowarefoundation.github.io/autoware-documentation/). This resource provides a thorough overview of the Autoware ecosystem, guiding you through its components, functionalities, and how to get started with development.
Autoware の広大な世界に飛び込み、Autoware Universe がどのように全体像に当てはまるかを理解するには、[Autoware ドキュメント](https://autowarefoundation.github.io/autoware-documentation/) から始めることをお勧めします。このリソースは、Autoware エコシステムの包括的な概要を提供し、そのコンポーネント、機能、開発の開始方法について案内します。

### Explore Autoware Universe documentation
### Autoware Universe ドキュメントの探査

For those looking to explore the specifics of Autoware Universe components, the [Autoware Universe Documentation](https://autowarefoundation.github.io/autoware.universe/), deployed with MKDocs, offers detailed insights.
Autoware Universe コンポーネントの詳細を探求したい場合は、MKDocs で展開された [Autoware Universe ドキュメント](https://autowarefoundation.github.io/autoware.universe/) で詳細な洞察が得られます。

## Code Coverage Metrics
## コードカバレッジの測定値

Below table shows the coverage rate of entire Autoware Universe and sub-components respectively.
以下の表は、Autoware Universe 全体とサブコンポーネントのそれぞれのカバレッジ率を示しています。

### Entire Project Coverage
### プロジェクト全体のカバー率

[![codecov](https://codecov.io/github/autowarefoundation/autoware.universe/graph/badge.svg?token=KQP68YQ65D)](https://codecov.io/github/autowarefoundation/autoware.universe)

### Component-wise Coverage
### コンポーネントごとのカバー率

You can check more details by clicking the badge and navigating the codecov website.
バッジをクリックして codecov Web サイトにアクセスすることで、詳細を確認できます。

| Component | Coverage |
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Common | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Common%20Packages&query=$.[0].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Common%20Packages) |
| Control | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Control%20Packages&query=$.[1].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Control%20Packages) |
| Evaluator | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Evaluator%20Packages&query=$.[2].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Evaluator%20Packages) |
| Launch | TBD |
| コンポーネント | カバレッジ |
|---|---|
| Common | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Common%20Packages&query=$.[0].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Common%20Packages) |
| Control | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Control%20Packages&query=$.[1].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Control%20Packages) |
| Evaluator | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Evaluator%20Packages&query=$.[2].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Evaluator%20Packages) |
| Launch | 未定 |
| Localization | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Localization%20Packages&query=$.[4].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Localization%20Packages) |
| Map | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Map%20Packages&query=$.[5].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Map%20Packages) |
| Perception | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Perception%20Packages&query=$.[6].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Perception%20Packages) |
| Planning | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Planning%20Packages&query=$.[7].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Planning%20Packages) |
| Sensing | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Sensing%20Packages&query=$.[8].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Sensing%20Packages) |
| Simulator | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Simulator%20Packages&query=$.[9].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Simulator%20Packages) |
| System | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=System%20Packages&query=$.[10].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=System%20Packages) |
| Vehicle | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Vehicle%20Packages&query=$.[11].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Vehicle%20Packages) |

<!-- NOTE: `query` fields to shields.io should be converted to slug form -->
<!--
TODO(soblin):
- dynamic `label` name(maybe not supported by shields.io)
- use https://github.com/marketplace/actions/dynamic-badges
-->
| Map | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Map%20Packages&query=$.[5].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Map%20Packages) |
| Perception | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Perception%20Packages&query=$.[6].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Perception%20Packages) |
| Planning | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Planning%20Packages&query=$.[7].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Planning%20Packages) |
| Sensing | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Sensing%20Packages&query=$.[8].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Sensing%20Packages) |
| Simulator | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Simulator%20Packages&query=$.[9].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Simulator%20Packages) |
| System | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=System%20Packages&query=$.[10].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=System%20Packages) |
| Vehicle | [![codecov](https://img.shields.io/badge/dynamic/json?url=https://codecov.io/api/v2/github/autowarefoundation/repos/autoware.universe/components&label=Vehicle%20Packages&query=$.[11].coverage)](https://app.codecov.io/gh/autowarefoundation/autoware.universe?components%5B0%5D=Vehicle%20Packages) |

## 自動運転ソフトウェア

### 目次

- [概要](#概要)
- [コンポーネント](#コンポーネント)
- [Perception](#Perception)
- [Planning](#Planning)
- [Control](#Control)
- [Autowareについて](#Autowareについて)
- [使用方法](#使用方法)
- [利用上の注意](#利用上の注意)

### 概要

自動運転ソフトウェアは、車両が人間介入なしで安全かつ効率的に道路を走行できるようにするソフトウェアシステムです。

### コンポーネント

自動運転ソフトウェアは、次の主要コンポーネントで構成されています。

- **Perception:** センサーからのデータを使用して、周囲の環境を認識します。
- **Planning:** 障害物を回避し、目的地に到達するための経路を計画します。
- **Control:** ステアリング、アクセル、ブレーキを制御し、計画された経路に従って車両を走行させます。

### Autowareについて

Autowareは、オープンソースの自動運転ソフトウェアプラットフォームです。次のような機能を提供します。

- Perception、Planning、Control用のモジュール
- シミュレーションとテスト用のツール
- リアルタイムオペレーティングシステム(ROS)との統合

### 使用方法

Autowareを使用するには、次の手順に従います。

1. Autowareをインストールします。
2. 必要に応じてモジュールをカスタマイズします。
3. システムをテストします。
4. 車両に展開します。

### 利用上の注意

Autowareを使用する際には、次の点に注意してください。

- システムは安全ではありません。実験的な目的でのみ使用してください。
- システムは常に人間の監視下で使用してください。
- システムは、悪天候やその他の困難な条件下では正しく動作しない可能性があります。

13 changes: 7 additions & 6 deletions common/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
# Common
# 共通

## Getting Started
## 概要

The Autoware.Universe Common folder consists of common and testing libraries that are used by other Autoware components, as well as useful plugins for visualization in RVIZ2.
Autoware.Universeの共通フォルダは、その他のAutowareコンポーネントで使用される共通ライブラリとテストライブラリ、およびRVIZ2での視覚化のための有益なプラグインで構成されています。

!!! note

In addition to the ones listed in this folder, users can also have a look at some of the add-ons in the `autoware_tools/common` documentation [page](https://autowarefoundation.github.io/autoware_tools/main/common/mission_planner_rviz_plugin/).
このフォルダに記載されているライブラリに加えて、ユーザーは `autoware_tools/common` ドキュメントでアドオンの一部を確認することもできます [ページ](https://autowarefoundation.github.io/autoware_tools/main/common/mission_planner_rviz_plugin/)

## Highlights
## ハイライト

Some of the commonly used libraries are:
一般的に使用されるライブラリの一部を示します。

1. `autoware_universe_utils`
2. `autoware_motion_utils`

3 changes: 1 addition & 2 deletions common/autoware_ad_api_specs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
# autoware_adapi_specs
404: 見つかりません

This package is a specification of Autoware AD API.
5 changes: 3 additions & 2 deletions common/autoware_component_interface_tools/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# autoware_component_interface_tools

This package provides the following tools for component interface.
このパッケージは、コンポーネントインターフェースの次のツールを提供します。

## service_log_checker

Monitor the service log of component_interface_utils and display if the response status is an error.
component_interface_utilsのサービスログを監視し、応答ステータスがエラーの場合に表示します。

5 changes: 3 additions & 2 deletions common/autoware_geography_utils/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# geography_utils

## Purpose
## 目的

このパッケージには、他のパッケージで使用される地理関連の関数が含まれていますので、必要に応じて参照してください。

This package contains geography-related functions used by other packages, so please refer to them as needed.
Loading
Loading