Skip to content

Commit 4ea7de1

Browse files
mitsudome-rpre-commit-ci[bot]xmfcx
authored
docs: update installation page (#762)
* docs: update installation page Signed-off-by: mitsudome-r <ryohsuke.mitsudome@tier4.jp> * style(pre-commit): autofix * Apply suggestions from code review Signed-off-by: mitsudome-r <ryohsuke.mitsudome@tier4.jp> Co-authored-by: Mete Fatih Cırıt <mfc@autoware.org> * style(pre-commit): autofix * fix: center position debian package installation button Signed-off-by: Ryohsuke Mitsudome <ryohsuke.mitsudome@tier4.jp> --------- Signed-off-by: mitsudome-r <ryohsuke.mitsudome@tier4.jp> Signed-off-by: Ryohsuke Mitsudome <ryohsuke.mitsudome@tier4.jp> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Mete Fatih Cırıt <mfc@autoware.org>
1 parent 2331db1 commit 4ea7de1

File tree

1 file changed

+44
-9
lines changed

1 file changed

+44
-9
lines changed

docs/installation/index.md

Lines changed: 44 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22

33
## Target platforms
44

5-
Autoware targets the platforms listed below. It may change in future versions of Autoware.
6-
7-
The Autoware Foundation provides no support on other platforms than those listed below.
5+
Autoware officially supports the platforms listed below.
6+
Support for additional platforms may be introduced in future releases.
87

98
### Architecture
109

@@ -32,32 +31,68 @@ For details of how to enable object detection and traffic light detection/classi
3231

3332
## Installing Autoware
3433

35-
There are five ways to set up Autoware. Choose one according to your preference. Autoware Core contains only the essential Autoware packages, and Autoware Universe contains the full Autoware stack.
34+
There are multiple ways to install Autoware depending on your use case and experience level. You may also choose to install Autoware Core which contains only the essential Autoware packages, or Autoware Universe which contains the full Autoware stack.
3635
For installation types, see the subsections below. If any issues occur during installation, refer to the [Support page](../community/support/index.md).
3736

38-
- [Autoware Core Docker installation](autoware/core-docker-installation.md)
39-
- [Autoware Core source installation](autoware/core-source-installation.md)
40-
- [Autoware Core Debian Package installation guide](autoware/core-debian-installation.md)
41-
- [Autoware Universe Docker installation](autoware/docker-installation.md)
42-
- [Autoware Universe source installation](autoware/source-installation.md)
37+
???+ abstract "Summary"
38+
39+
<div class="grid cards" markdown>
40+
41+
- **Autoware Core**
42+
43+
---
44+
45+
- Contains only the essential Autoware packages
46+
- Basic functionality for lane driving and obstacle detection
47+
- No NVIDIA dependency
48+
- No neural networks for detecting objects (yet)
49+
50+
- **Autoware Universe** ⭐
51+
52+
---
53+
54+
- Contains full stack Autoware and 3rd party packages
55+
- ML-based perception/planning capabilities
56+
57+
</div>
4358

4459
### 1. Docker installation
4560

4661
Autoware's Open AD Kit containers enable you to run and develop Autoware easily on your host machine, ensuring the same environment for development and deployment without installing dependencies.
4762

4863
[Open AD Kit](https://autoware.org/open-ad-kit/) is the first [SOAFEE Blueprint](https://www.soafee.io/about/charter) for autonomous driving, offering extensible modular containerized workloads to simplify running Autoware's AD stack on distributed systems. Refer to the [Open AD Kit Documentation](https://autowarefoundation.github.io/openadkit/) for more details.
4964

65+
<div style="text-align: center;" markdown="1">
66+
67+
[:fa-cl-s fa-circle-arrow-right: Autoware Universe Docker Installation ⭐](autoware/docker-installation.md){ .md-button style="margin: 5px" }
68+
[:fa-cl-s fa-circle-arrow-right: Autoware Core Docker Installation](autoware/core-docker-installation.md){ .md-button style="margin: 5px" }
69+
70+
</div>
71+
5072
### 2. Source installation
5173

5274
Source installation is for the cases where more granular control of the installation environment is needed.
5375
It is recommended for experienced users or people who want to customize their environment.
5476
Note that some problems may occur depending on your local environment.
5577

78+
<div style="text-align: center;" markdown="1">
79+
80+
[:fa-cl-s fa-circle-arrow-right: Autoware Universe Source Installation ⭐](autoware/source-installation.md){ .md-button style="margin: 5px" }
81+
[:fa-cl-s fa-circle-arrow-right: Autoware Core Source Installation](autoware/core-source-installation.md){ .md-button style="margin: 5px" }
82+
83+
</div>
84+
5685
### 3. Debian Package installation
5786

5887
Autoware Core packages are available on the ROS build farm.
5988
If you have an environment where ROS is set up, Autoware packages can be easily installed and used with other packages in the ROS ecosystem.
6089

90+
<div style="text-align: center;" markdown="1">
91+
92+
[:fa-cl-s fa-circle-arrow-right: Autoware Core Debian Package Installation](autoware/core-debian-installation.md){ .md-button }
93+
94+
</div>
95+
6196
## Installing related tools
6297

6398
Some other tools are required depending on the evaluation you want to do.

0 commit comments

Comments
 (0)