From 0f6edef48d681ac4f48e648bdc8136add6cc0e93 Mon Sep 17 00:00:00 2001 From: Jenn Nguyen Date: Fri, 15 Jul 2022 13:19:33 -0700 Subject: [PATCH] Ignition -> Gazebo (#178) Signed-off-by: Jenn Nguyen --- README.md | 51 +++++++++++++++++++++++++-------------------------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index e29f8ab5..5cb86653 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,20 @@ -# Ignition Launch : Run and manage programs and plugins +# Gazebo Launch : Run and manage programs and plugins **Maintainer:** nate AT openrobotics DOT org -[![GitHub open issues](https://img.shields.io/github/issues-raw/ignitionrobotics/ign-launch.svg)](https://github.com/ignitionrobotics/ign-launch/issues) -[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/ignitionrobotics/ign-launch.svg)](https://github.com/ignitionrobotics/ign-launch/pulls) +[![GitHub open issues](https://img.shields.io/github/issues-raw/gazebosim/gz-launch.svg)](https://github.com/gazebosim/gz-launch/issues) +[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/gazebosim/gz-launch.svg)](https://github.com/gazebosim/gz-launch/pulls) [![Discourse topics](https://img.shields.io/discourse/https/community.gazebosim.org/topics.svg)](https://community.gazebosim.org) [![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)](https://www.apache.org/licenses/LICENSE-2.0) Build | Status -- | -- -Test coverage | [![codecov](https://codecov.io/gh/ignitionrobotics/ign-launch/branch/ign-launch2/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-launch) -Ubuntu Bionic | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_launch-ci-ign-launch2-bionic-amd64)](https://build.osrfoundation.org/job/ignition_launch-ci-ign-launch2-bionic-amd64) +Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-launch/branch/ign-launch2/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-launch/branch/ign-launch2) +Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_launch-ci-ign-launch2-focal-amd64)](https://build.osrfoundation.org/job/ignition_launch-ci-ign-launch2-focal-amd64) Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_launch-ci-ign-launch2-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_launch-ci-ign-launch2-homebrew-amd64) Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_launch-ci-ign-launch2-windows7-amd64)](https://build.osrfoundation.org/job/ignition_launch-ci-ign-launch2-windows7-amd64) -Ignition Launch, a component of [Ignition -Robotics](https://ignitionrobotics.org), provides a command line interface +Gazebo Launch, a component of [Gazebo](https://gazebosim.org), provides a command line interface to run and manager application and plugins. # Table of Contents @@ -50,7 +49,7 @@ to run and manager application and plugins. # Features -Ignition Launch is used to run and manage plugins and programs. A +Gazebo Launch is used to run and manage plugins and programs. A configuration script can be used to specify which programs and plugins to execute. Alternatively, individual programs and plugins can be run from the command line. Example configuration scripts are located in the `examples` @@ -58,7 +57,7 @@ directory. 1. Automatic ERB parsing of configuration files. 1. Pass arguments to launch files from the command line. -1. Plugins to launch Gazebo, joystick interface, and a websocket server for +1. Plugins to launch Gazebo Sim, joystick interface, and a websocket server for simulation. # Install @@ -93,7 +92,7 @@ necessary prerequisites followed by building from source. sudo apt-get -y install cmake build-essential curl cppcheck g++-8 doxygen ruby-ronn libtinyxml2-dev software-properties-common ``` -1. Install required Ignition libraries +1. Install required Gazebo libraries ``` sudo sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list' @@ -120,16 +119,16 @@ necessary prerequisites followed by building from source. 1. Clone the repository ``` - git clone https://github.com/ignitionrobotics/ign-launch + git clone https://github.com/gazebosim/gz-launch ``` 2. Configure and build ``` - cd ign-launch; mkdir build; cd build; cmake ..; make + cd gz-launch; mkdir build; cd build; cmake ..; make ``` -3. Optionally, install Ignition Launch +3. Optionally, install Gazebo Launch ``` sudo make install @@ -137,11 +136,11 @@ necessary prerequisites followed by building from source. # Usage -Sample launch configuration files are in the [examples directory](https://github.com/ignitionrobotics/ign-launch/blob/ign-launch2/examples/). +Sample launch configuration files are in the [examples directory](https://github.com/gazebosim/gz-launch/blob/ign-launch2/examples/). **Example** -1. Run a configuration that launches [Gazebo](https://ignitionrobotics.org/libs/gazebo). +1. Run a configuration that launches [Gazebo Sim](https://gazebosim.org/libs/gazebo). ``` ign launch gazebo.ign @@ -153,7 +152,7 @@ In the event that the installation is a mix of Debian and from source, command line tools from `ign-tools` may not work correctly. A workaround for a single package is to define the environment variable -`IGN_CONFIG_PATH` to point to the location of the Ignition library installation, +`IGN_CONFIG_PATH` to point to the location of the Gazebo library installation, where the YAML file for the package is found, such as ``` export IGN_CONFIG_PATH=/usr/local/share/ignition @@ -162,7 +161,7 @@ export IGN_CONFIG_PATH=/usr/local/share/ignition However, that environment variable only takes a single path, which means if the installations from source are in different locations, only one can be specified. -Another workaround for working with multiple Ignition libraries on the command +Another workaround for working with multiple Gazebo libraries on the command line is using symbolic links to each library's YAML file. ``` mkdir ~/.ignition/tools/configs -p @@ -174,11 +173,11 @@ ln -s /usr/local/share/ignition/transportlog7.yaml . export IGN_CONFIG_PATH=$HOME/.ignition/tools/configs ``` -This issue is tracked [here](https://github.com/ignitionrobotics/ign-tools/issues/8). +This issue is tracked [here](https://github.com/gazebosim/gz-tools/issues/8). # Documentation -API and tutorials can be found at [https://ignitionrobotics.org/libs/launch](https://ignitionrobotics.org/libs/launch). +API and tutorials can be found at [https://gazebosim.org/libs/launch](https://gazebosim.org/libs/launch). You can also generate the documentation from a clone of this repository by following these steps. @@ -191,13 +190,13 @@ You can also generate the documentation from a clone of this repository by follo 2. Clone the repository ``` - git clone https://github.com/ignitionrobotics/ign-launch + git clone https://github.com/gazebosim/gz-launch ``` 3. Configure and build the documentation. ``` - cd ign-launch; mkdir build; cd build; cmake ../; make doc + cd gz-launch; mkdir build; cd build; cmake ../; make doc ``` 4. View the documentation by running the following command from the build directory. @@ -229,7 +228,7 @@ Follow these steps to run tests and static code analysis in your clone of this r Refer to the following table for information about important directories and files in this repository. ``` -ign-launch +gz-launch ├── examples Example launch configurations. ├── include/ignition/launch Header files. ├── src Source files and unit tests. @@ -244,17 +243,17 @@ ign-launch # Contributing -Please see the [contribution guide](https://ignitionrobotics.org/docs/all/contributing). +Please see the [contribution guide](https://gazebosim.org/docs/all/contributing). # Code of Conduct Please see -[CODE_OF_CONDUCT.md](https://github.com/ignitionrobotics/ign-gazebo/blob/main/CODE_OF_CONDUCT.md). +[CODE_OF_CONDUCT.md](https://github.com/gazebosim/gz-gazebo/blob/main/CODE_OF_CONDUCT.md). # Versioning -This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the [Ignition Robotics project](https://ignitionrobotics.org) which periodically releases a versioned set of compatible and complimentary libraries. See the [Ignition Robotics website](https://ignitionrobotics.org) for version and release information. +This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the [Gazebo project](https://gazebosim.org) which periodically releases a versioned set of compatible and complimentary libraries. See the [Gazebo website](https://gazebosim.org) for version and release information. # License -This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). See also the [LICENSE](https://github.com/ignitionrobotics/ign-launch/blob/main/LICENSE) file. +This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). See also the [LICENSE](https://github.com/gazebosim/gz-launch/blob/main/LICENSE) file.