Skip to content

Commit

Permalink
Merge pull request #1397 from tier4/RJD-1201/fix_quick_start
Browse files Browse the repository at this point in the history
[RJD-1201] Fix QuickStart.md
  • Loading branch information
hakuturu583 authored Sep 27, 2024
2 parents 3c04908 + 9ca65da commit 5c0a1c3
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/user_guide/QuickStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Scenario Simulator v2 with Autoware Universe

This guide provides step-by-step instructions for building and running **Scenario Simulator v2** alongside [**Autoware Universe**](https://github.com/autowarefoundation/autoware).<br> It covers the required setup and prerequisites.
This guide provides step-by-step instructions for building and running **Scenario Simulator v2** alongside [**Autoware Universe**](https://github.com/autowarefoundation/autoware). It covers the required setup and prerequisites.

## Prerequisites

Expand Down Expand Up @@ -32,8 +32,8 @@ This guide provides step-by-step instructions for building and running **Scenari
```bash
./setup-dev-env.sh
```
!!! Note
This step will install necessary dependencies, including ROS 2, if not already installed. <br> Make sure to confirm and agree with the licenses for NVIDIA libraries like [CUDA](https://docs.nvidia.com/cuda/eula/index.html), [cuDNN](https://docs.nvidia.com/deeplearning/cudnn/latest/reference/eula.html), and [TensorRT](https://docs.nvidia.com/deeplearning/tensorrt/sla/index.html).
!!! note
This step will install necessary dependencies, including ROS 2, if not already installed. <br> Make sure to confirm and agree with the licenses for NVIDIA libraries like [CUDA](https://docs.nvidia.com/cuda/eula/index.html), [cuDNN](https://docs.nvidia.com/deeplearning/cudnn/latest/reference/eula.html), and [TensorRT](https://docs.nvidia.com/deeplearning/tensorrt/sla/index.html).

5. Install dependent ROS packages.
```bash
Expand All @@ -45,8 +45,8 @@ This guide provides step-by-step instructions for building and running **Scenari
```bash
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
```
!!! Note
For detailed guidance on build issues and troubleshooting, please refer to the [Autoware Troubleshooting Guide](https://autowarefoundation.github.io/autoware-documentation/main/support/troubleshooting/#build-issues).
!!! note
For detailed guidance on build issues and troubleshooting, please refer to the [Autoware Troubleshooting Guide](https://autowarefoundation.github.io/autoware-documentation/main/support/troubleshooting/#build-issues).

![Build success](../image/ss2_autoware_build_result.png)
*As a result of running the `colcon build` command, all packages should be built successfully.*
Expand Down Expand Up @@ -88,8 +88,8 @@ This guide provides step-by-step instructions for building and running **Scenari
sensor_model:=sample_sensor_kit \
vehicle_model:=sample_vehicle timeout:=120.0
```
!!! Note
To modify parameters of random testing and to obtain more details about the test results and the **result.junit.xml** file (which is saved by default in the **/tmp** directory), please refer to the **random_test_runner** [documentation](random_test_runner/Usage.md).
!!! note
To modify parameters of random testing and to obtain more details about the test results and the **result.junit.xml** file (which is saved by default in the **/tmp** directory), please refer to the **random_test_runner** [documentation](random_test_runner/Usage.md).

![Launching random_test_runner](../image/random_test_runner_launch.gif)
*The process of launching the `random_test_runner` node.*
Expand Down

0 comments on commit 5c0a1c3

Please sign in to comment.