From 4c4ac269bb3b251c78515d596dc9370f379a4fcd Mon Sep 17 00:00:00 2001 From: sergi-e Date: Wed, 2 Sep 2020 11:14:55 +0200 Subject: [PATCH] First iteration on J comments --- Docs/ros_installation.md | 14 +++++++------- Docs/start_quickstart.md | 18 +++++++++--------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/Docs/ros_installation.md b/Docs/ros_installation.md index 116004cff..52cce9504 100644 --- a/Docs/ros_installation.md +++ b/Docs/ros_installation.md @@ -2,7 +2,7 @@ * [__Requirements__](#requirements) * [__Bridge installation__](#bridge-installation) - * [A. Using deb repository](#a-using-deb-repository) + * [A. Using Debian repository](#a-using-debian-repository) * [B. Using source repository](#b-using-source-repository) * [__Run the ROS bridge__](#run-the-ros-bridge) * [__Setting CARLA__](#setting-carla) @@ -13,7 +13,7 @@ The ROS bridge enables two-way communication between ROS and CARLA. The informat ## Requirements ### ROS Kinetic/Melodic -* __ROS Kinetic/Melodic.__ Install ROS [Melodic](http://wiki.ros.org/melodic/Installation/Ubuntu), for Ubuntu 18.04, or [Kinetic](http://wiki.ros.org/kinetic/Installation), for Ubuntu 16.04. ROS packages may be required, depending on the user needs. [rviz](http://wiki.ros.org/rviz) to visualize ROS data. +* __ROS Kinetic/Melodic.__ Install ROS [Melodic](http://wiki.ros.org/melodic/Installation/Ubuntu), for Ubuntu 18.04, or [Kinetic](http://wiki.ros.org/kinetic/Installation), for Ubuntu 16.04. ROS packages may be required, depending on the user needs. [rviz](http://wiki.ros.org/rviz) to visualize ROS data.j * __CARLA 0.9.7 or later.__ Previous versions are not compatible with the ROS bridge. Follow the [quick start installation](start_quickstart.md) or make the build for the corresponding platform. !!! Important @@ -22,22 +22,22 @@ The ROS bridge enables two-way communication between ROS and CARLA. The informat --- ## Bridge installation -### A. Using deb repository +### A. Using Debian repository -Set up the deb repository in the system. +Set up the Debian repository in the system. ```sh sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 1AF1527DE64CB8D9 sudo add-apt-repository "deb [arch=amd64] http://dist.carla.org/carla $(lsb_release -sc) main" ``` -Install CARLA and check for the installation in the `/opt/` folder. +Install the ROS bridge, and check for the installation in the `/opt/` folder. ```sh -sudo apt-get update # Update the repository +sudo apt-get update # Update the Debian package index sudo apt-get install carla-ros-bridge # Install the latest ROS bridge version, or update the current installation ``` This repository contains features from CARLA 0.9.10 and later versions. To install a specific version add the version tag to the installation command. ```sh -sudo apt-get install carla-ros-bridge==0.9.10-1 # In this case, "0.9.10" refers to the ROS bridge version, and "-1" to a deb tag, which usually will always be the same. +sudo apt-get install carla-ros-bridge=0.9.10-1 # In this case, "0.9.10" refers to the ROS bridge version, and "1" to the Debian revision. ``` !!! Important diff --git a/Docs/start_quickstart.md b/Docs/start_quickstart.md index feb8daea5..67f39fb98 100644 --- a/Docs/start_quickstart.md +++ b/Docs/start_quickstart.md @@ -3,7 +3,7 @@ * __[Installation summary](#installation-summary)__ * __[Requirements](#requirements)__ * __[CARLA installation](#carla-installation)__ - * [A. deb CARLA installation](#a-deb-carla-installation) + * [A. Debian CARLA installation](#a-debian-carla-installation) * [B. Package installation](#b-package-installation) * __[Import additional assets](#import-additional-assets)__ * __[Running CARLA](#running-carla)__ @@ -25,13 +25,13 @@ # There are two different ways to install CARLA. -# Option A) deb package installation +# Option A) Debian package installation # This repository contains CARLA 0.9.10 and later. To install previous CARLA versions, change to a previous version of the docs using the pannel in the bottom right part of the window. sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 1AF1527DE64CB8D9 sudo add-apt-repository "deb [arch=amd64] http://dist.carla.org/carla $(lsb_release -sc) main" sudo apt-get update sudo apt-get install carla-simulator # Install the latest CARLA version or update the current installation. -sudo apt-get install carla-simulator==0.9.10-1 # install a specific CARLA version. +sudo apt-get install carla-simulator=0.9.10-1 # install a specific CARLA version. cd /opt/carla-simulator/bin ./CarlaUE4.sh @@ -70,26 +70,26 @@ To install both modules using [pip](https://pip.pypa.io/en/stable/installing/), --- ## CARLA installation -The __deb installation__ is the easiest way to get the latest release in Linux. +The __Debian installation__ is the easiest way to get the latest release in Linux. __Download the GitHub repository__ to get either a specific release or the Windows version of CARLA. -### A. deb CARLA installation +### A. Debian CARLA installation -Set up the deb repository in the system. +Set up the Debian repository in the system. ```sh sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 1AF1527DE64CB8D9 sudo add-apt-repository "deb [arch=amd64] http://dist.carla.org/carla $(lsb_release -sc) main" ``` Install CARLA and check for the installation in the `/opt/` folder. ```sh -sudo apt-get update # Update the repository +sudo apt-get update # Update the Debian package index sudo apt-get install carla-simulator # Install the latest CARLA version, or update the current installation cd /opt/carla-simulator # Open the folder where CARLA is installed ``` This repository contains CARLA 0.9.10 and later versions. To install a specific version add the version tag to the installation command. ```sh -sudo apt-get install carla-simulator==0.9.10-1 # In this case, "0.9.10" refers to a CARLA version, and "-1" to a deb tag, which usually will always be the same. +sudo apt-get install carla-simulator=0.9.10-1 # In this case, "0.9.10" refers to a CARLA version, and "1" to the Debian revision. ``` !!! Important @@ -137,7 +137,7 @@ Open a terminal in the main CARLA folder. Run the following command to execute t > CarlaUE4.exe ``` !!! Important - In the __deb installation__, `CarlaUE4.sh` will be in `/opt/carla/bin/`, instead of the main `carla/` folder where it normally is. + In the __Debian installation__, `CarlaUE4.sh` will be in `/opt/carla-simulator`, instead of the main `carla/` folder where it normally is. A window containing a view over the city will pop up. This is the _spectator view_. To fly around the city use the mouse and `WASD` keys (while clicking). The server simulator is now running and waiting for a client to connect and interact with the world. Now it is time to start running scripts. The following example will spawn some life into the city: