diff --git a/docs/user_guide/QuickStart.md b/docs/user_guide/QuickStart.md index dbd7da67cee..f42ad70ad20 100644 --- a/docs/user_guide/QuickStart.md +++ b/docs/user_guide/QuickStart.md @@ -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).
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 @@ -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.
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.
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 @@ -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.* @@ -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.*