Skip to content

Commit a180504

Browse files
include main page plus explanation to autoware tools
Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp>
1 parent 2b6f4aa commit a180504

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

common/.pages

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
nav:
2+
- 'Introduction': common
23
- 'Testing Libraries':
34
- 'autoware_testing': common/autoware_testing/design/autoware_testing-design
4-
- 'fake_test_node': fake_test_node/design/fake_test_node-design
5+
- 'fake_test_node': common/fake_test_node/design/fake_test_node-design
56
- 'Common Libraries':
67
- 'autoware_auto_common':
78
- 'comparisons': common/autoware_auto_common/design/comparisons
89
- 'autoware_auto_geometry':
910
- 'interval': common/autoware_auto_geometry/design/interval
1011
- 'polygon intersection 2d': common/autoware_auto_geometry/design/polygon_intersection_2d-design
1112
- 'spatial hash': common/autoware_auto_geometry/design/spatial-hash-design
12-
- 'autoware_auto_tf2': common/autoware_auto_tf2/design
13+
- 'autoware_auto_tf2': common/autoware_auto_tf2/design/autoware-auto-tf2-design
1314
- 'autoware_point_types': common/autoware_point_types
1415
- 'Cuda Utils': common/cuda_utils
1516
- 'Geography Utils': common/geography_utils

common/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Common
2+
3+
## Getting Started
4+
5+
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.
6+
7+
!!! note
8+
9+
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/).
10+
11+
## Highlights
12+
13+
Some of the commonly used libraries are:
14+
1. `tier4_autoware_utils`
15+
2. `motion_utils`

0 commit comments

Comments
 (0)