Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ign -> gz Namespace Migration : gz-sim #1496

Merged
merged 49 commits into from
May 29, 2022
Merged
Show file tree
Hide file tree
Changes from 40 commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
ceb4b58
Update header guards
methylDragon May 18, 2022
f36db49
Migrate namespaces
methylDragon May 18, 2022
0dae9fd
Add migration line
methylDragon May 18, 2022
02a6f2b
Implement deprecation trick
methylDragon May 18, 2022
04a5e50
Add deprecation test
methylDragon May 18, 2022
53edf30
Include config.hh
methylDragon May 18, 2022
42adece
Migrate inline namespaces
methylDragon May 20, 2022
e29e19b
Migrate config.hh and config.hh.in
methylDragon May 20, 2022
e9e20fd
Migrate includes to gz
methylDragon May 20, 2022
bf48142
Mention gz headers in migration, and fix Gz mentions
methylDragon May 20, 2022
1342d65
Update config.hh
methylDragon May 20, 2022
5fad683
Migrate Export.hh macros and update deprecated test
methylDragon May 20, 2022
df52491
Greedy macro migration
methylDragon May 20, 2022
f337a7a
Migrate to gz.msgs
methylDragon May 20, 2022
3f21347
Migrate to sim::
methylDragon May 20, 2022
1d0f94c
Migrate github links
methylDragon May 20, 2022
3e398fe
Fix more broken references and migrate to gz-sim
methylDragon May 20, 2022
6bb7363
Migrate user-facing Ignition to Gazebo
methylDragon May 20, 2022
0c5098e
Fix more broken references
methylDragon May 20, 2022
789bd4c
Migrate gz-common logging calls
methylDragon May 20, 2022
a83251e
Revert plugin names to ignition-gazebo
methylDragon May 20, 2022
61c9517
Fix bug in inline namespace
methylDragon May 20, 2022
4fd5d72
Migrate `Ignition::Gazebo` -> `Gz::Sim`
methylDragon May 21, 2022
00baace
`Gazebo` -> `Gazebo Sim` where applicable
methylDragon May 23, 2022
d683dd9
`Gazebo Robotics` -> `Gazebo`
methylDragon May 23, 2022
86aad44
`ignitionrobotics` -> `gazebosim`
methylDragon May 23, 2022
52b7dc7
Revert migration for fuel.ignitionrobotics.org
methylDragon May 23, 2022
e0c941f
Rollback osrf-migration.github.io migrations
methylDragon May 24, 2022
cec8795
Add "Deprecated" to ticktock comment
methylDragon May 24, 2022
81a2d2c
Migrate Ignition's -> Gazebo's
methylDragon May 25, 2022
0386bbb
Wording changes
methylDragon May 25, 2022
2c2ecde
Migrate `ign-sim` -> `ign-gazebo`
methylDragon May 25, 2022
fafd557
Migrate `igndbg` -> `gzdbg`
methylDragon May 25, 2022
f1bedce
Revert GZ_SIM_ env vars to IGNITION_GAZEBO_
methylDragon May 25, 2022
dfa25aa
Migrate `GZ_GAZEBO` -> `GZ_SIM` for header guards
methylDragon May 25, 2022
009344d
Migrate `Gazebo's` -> `Gazebo Sim's`
methylDragon May 25, 2022
0dfe036
Wording changes
methylDragon May 25, 2022
a5493d3
Fix GZ_SIM_SERVER_CONFIG_PATH C++ macro
methylDragon May 26, 2022
e00612f
`Gazebo` -> `Gazebo Sim`
methylDragon May 26, 2022
fa1601b
Fix deprecated test namespaces
methylDragon May 26, 2022
5c21f04
Add system plugin aliases
methylDragon May 27, 2022
5b19d0b
Fix buggy macro `IGN_GAZEBO_SERVER_CONFIG_PATH`
methylDragon May 27, 2022
f73e7a5
`Gazebo GUI/Server` -> `Gazebo Sim GUI/Server`
methylDragon May 27, 2022
b548c3e
fix build
chapulina May 28, 2022
4512c38
sort out ~/.gz directory
chapulina May 28, 2022
2b41b35
Revert env vars that need to be tick-tocked
chapulina May 28, 2022
0c27fb0
standardize and fix plugin aliases
chapulina May 28, 2022
e0a84e9
support old logs, fix build
chapulina May 29, 2022
197b029
restore README
chapulina May 29, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/ci/after_make.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ make install
export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:/usr/local/lib

# For ign-tools
export IGN_CONFIG_PATH=/usr/local/share/ignition
export GZ_CONFIG_PATH=/usr/local/share/ignition

# For rendering / window tests
Xvfb :1 -screen 0 1280x1024x24 &
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ jobs:
id: ci
uses: ignition-tooling/action-ignition-ci@jammy
with:
# per bug https://github.com/ignitionrobotics/ign-gazebo/issues/1409
# per bug https://github.com/gazebosim/gz-sim/issues/1409
cmake-args: '-DBUILD_DOCS=OFF'
10 changes: 5 additions & 5 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ set (CMAKE_CXX_STANDARD 17)
# Set project-specific options
#============================================================================

option(ENABLE_PROFILER "Enable Ignition Profiler" FALSE)
option(ENABLE_PROFILER "Enable Gazebo Profiler" FALSE)

if(ENABLE_PROFILER)
add_definitions("-DIGN_PROFILER_ENABLE=1")
Expand Down Expand Up @@ -201,10 +201,10 @@ else()
endif()
endif()
# Plugin install dirs
set(IGNITION_GAZEBO_PLUGIN_INSTALL_DIR
set(GZ_SIM_PLUGIN_INSTALL_DIR
${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}/ign-${IGN_DESIGNATION}-${PROJECT_VERSION_MAJOR}/plugins
)
set(IGNITION_GAZEBO_GUI_PLUGIN_INSTALL_DIR
set(GZ_SIM_GUI_PLUGIN_INSTALL_DIR
${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}/ign-${IGN_DESIGNATION}-${PROJECT_VERSION_MAJOR}/plugins/gui
)

Expand Down Expand Up @@ -233,7 +233,7 @@ configure_file(${CMAKE_SOURCE_DIR}/tools/desktop/ignition-gazebo.svg.in ${CMAKE_

# disable doxygen on macOS due to issues with doxygen 1.9.0
# there is an unreleased fix; revert this when 1.9.1 is released
# https://github.com/ignitionrobotics/ign-gazebo/issues/520
# https://github.com/gazebosim/gz-sim/issues/520
if (NOT APPLE)
ign_create_docs(
API_MAINPAGE_MD "${CMAKE_BINARY_DIR}/api.md"
Expand All @@ -256,7 +256,7 @@ if(TARGET doc)
endif()

# TICKTOCK MASTER HEADER (to bypass IGN_DESIGNATION)
# TODO(CH3): Remove on tock
# TODO(CH3): Deprecated. Remove on tock
configure_file(
${CMAKE_CURRENT_BINARY_DIR}/include/gz/${IGN_DESIGNATION}.hh
${CMAKE_CURRENT_BINARY_DIR}/include/gz/sim.hh
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [https://ignitionrobotics.org/support](https://ignitionrobotics.org/support). All
reported by contacting the project team at [https://gazebosim.org/support](https://gazebosim.org/support). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See the [Ignition Robotics contributing guide](https://ignitionrobotics.org/docs/all/contributing).
See the [Gazebo contributing guide](https://gazebosim.org/docs/all/contributing).
1,980 changes: 990 additions & 990 deletions Changelog.md

Large diffs are not rendered by default.

61 changes: 32 additions & 29 deletions Migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,29 @@ Deprecated code produces compile-time warnings. These warning serve as
notification to users that their code should be upgraded. The next major
release will remove the deprecated code.

## Ignition Gazebo 6.x to 7.0
## Gazebo Sim 6.x to 7.0

* **Deprecated**
+ The `ParticleEmitter2` system was renamed to `ParticleEmitter`. The
`ParticleEmitter2` system is now deprecated. Please use the
`ParticleEmitter` system.
`ParticleEmitter` system.
+ The `ignition::gazebo` namespace is deprecated and will be removed in future versions. Use `gz::sim` instead.
+ Header files under `ignition/...` are deprecated and will be removed in future versions.
Use `gz/...` instead.

## Ignition Gazebo 6.1 to 6.2
## Gazebo Sim 6.1 to 6.2

* If no `<namespace>` is given to the `Thruster` plugin, the namespace now
defaults to the model name, instead of an empty string.

## Ignition Gazebo 5.x to 6.x
## Gazebo Sim 5.x to 6.x

* The ParticleEmitter system is deprecated. Please use the ParticleEmitter2
system.

* Marker example has been moved to Ignition GUI.
* Marker example has been moved to Gazebo GUI.

* Some GUI plugins have been moved to Ignition GUI. Gazebo users don't need to
* Some GUI plugins have been moved to Gazebo GUI. Gazebo Sim users don't need to
change their configuration files, the plugins will be loaded the same way.
* Grid Config
* Tape Measure
Expand Down Expand Up @@ -80,20 +83,20 @@ since pose information is being logged in the `changed_state` topic.
* The `gui.config` and `server.config` files are now located in a versioned
folder inside `$HOME/.ignition/gazebo`, i.e. `$HOME/.ignition/gazebo/6/gui.config`.

* The `Component::Clone` method has been marked `const` to reflect that it
* The `Component::Clone` method has been marked `const` to reflect that it
should not mutate internal component state. Component implementations that
overrode the `Clone` method must also be marked `const`.

## Ignition Gazebo 5.2 to 5.3
## Gazebo Sim 5.2 to 5.3

* If no `<namespace>` is given to the `Thruster` plugin, the namespace now
defaults to the model name, instead of an empty string.

## Ignition Gazebo 4.x to 5.x
## Gazebo Sim 4.x to 5.x

* Use `cli` component of `ignition-utils1`.

* `ignition::gazebo::RenderUtil::SelectedEntities()` now returns a
* `gz::sim::RenderUtil::SelectedEntities()` now returns a
`const std::vector<Entity> &` instead of forcing a copy. The calling code
should create a copy if it needs to modify the vector in some way.

Expand All @@ -104,30 +107,30 @@ since pose information is being logged in the `changed_state` topic.
* `/<prefix>/<sensor_name>` -> `/<prefix>/<sensor_name>/image`
* `/<prefix>/camera_info` -> `/<prefix>/<sensor_name>/camera_info`

* Various `GuiEvent`s were deprecated in favor of their Ignition GUI
* Various `GuiEvent`s were deprecated in favor of their Gazebo GUI
equivalents.
* **Deprecated** `ignition::gazebo::gui::SnapIntervals`
* **Replacement** `ignition::gui::SnapIntervals`
* **Deprecated** `ignition::gazebo::gui::Render`
* **Replacement** `ignition::gui::Render`
* **Deprecated** `ignition::gazebo::gui::SpawnPreviewModel`
* **Replacement** `ignition::gui::SpawnFromDescription`
* **Deprecated** `ignition::gazebo::gui::SnapPreviewPath`
* **Replacement** `ignition::gui::SnapFromPath`
* **Deprecated** `gz::sim::gui::SnapIntervals`
* **Replacement** `gz::gui::SnapIntervals`
* **Deprecated** `gz::sim::gui::Render`
* **Replacement** `gz::gui::Render`
* **Deprecated** `gz::sim::gui::SpawnPreviewModel`
* **Replacement** `gz::gui::SpawnFromDescription`
* **Deprecated** `gz::sim::gui::SnapPreviewPath`
* **Replacement** `gz::gui::SnapFromPath`

* The `<direction>` tag of spot lights was previously not parsed by the
scene, so all spot lights shone in the direction corresponding to the
default `0 0 -1`. Since 5.x, the `<direction>` tag is correctly
processed.

## Ignition Gazebo 4.0.0 to 4.X.X
## Gazebo Sim 4.0.0 to 4.X.X

* Ignition Gazebo 4.0.0 enabled double sided material by default but this
* Gazebo Sim 4.0.0 enabled double sided material by default but this
caused shadow artifacts to appear on some meshes. Double sided material is
now disabled and made an opt-in feature. Users can configure this property
in SDF by setting the `<visual><material><double_sided>` SDF element.

## Ignition Gazebo 3.x to 4.x
## Gazebo Sim 3.x to 4.x

* The `RenderUtil::SetEnabledSensors` callback in gazebo rendering has a new
required function argument for the Entity of the sensor.
Expand All @@ -136,7 +139,7 @@ in SDF by setting the `<visual><material><double_sided>` SDF element.
std::string(const sdf::Sensor &, const std::string &)>)`
* ***Replacement***
`public: void SetEnableSensors(bool, std::function<
std::string(const gazebo::Entity &,
std::string(const sim::Entity &,
const sdf::Sensor &, const std::string &)>)`

* Log playback using `<path>` SDF parameter is removed. Use --playback command
Expand All @@ -146,15 +149,15 @@ in SDF by setting the `<visual><material><double_sided>` SDF element.
* **Deprecated**: `Entity EntityFromNode(const rendering::NodePtr &_node) const;`
* **Replacement**: `Entity entity = std::get<int>(visual->UserData("gazebo-entity"));`

## Ignition Gazebo 3.12.0 to 3.X.X
## Gazebo Sim 3.12.0 to 3.X.X

* Some sensors will only have the `SensorTopic` component after the 1st iteration.

## Ignition Gazebo 2.x to 3.x
## Gazebo Sim 2.x to 3.x

* Use ign-rendering3, ign-sensors3 and ign-gui3.

## Ignition Gazebo 1.x to 2.x
## Gazebo Sim 1.x to 2.x

* Changed component data types:
* `Altimeter` now uses `sdf::Sensor`
Expand All @@ -176,15 +179,15 @@ in SDF by setting the `<visual><material><double_sided>` SDF element.
* The `entity_name` field in the messages published by the imu system is
updated to report its scoped name.

* Log files generated from Ignition Gazebo 1.X are no longer compatible with
Gazebo 2+ for playback. [BitBucket pull request
* Log files generated from Gazebo Sim 1.X are no longer compatible with
Gazebo Sim 2+ for playback. [BitBucket pull request
#257](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-gazebo/pull-requests/257)
added an SDF message to the start of log files.

* Log playback using `<path>` SDF parameter is deprecated. Use `--playback`
command line argument instead.

## Ignition Gazebo 1.0.2 to 1.1.0
## Gazebo Sim 1.0.2 to 1.1.0

* All headers in `gazebo/network` are no longer installed.

Expand Down
2 changes: 1 addition & 1 deletion NEWS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
http://ignitionrobotics.org
http://gazebosim.org
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Ignition Gazebo : A Robotic Simulator
# Gazebo Sim : A Robotic Simulator

**Maintainer:** louise AT openrobotics DOT org

[![GitHub open issues](https://img.shields.io/github/issues-raw/ignitionrobotics/ign-gazebo.svg)](https://github.com/ignitionrobotics/ign-gazebo/issues)
[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/ignitionrobotics/ign-gazebo.svg)](https://github.com/ignitionrobotics/ign-gazebo/pulls)
[![GitHub open issues](https://img.shields.io/github/issues-raw/gazebosim/gz-sim.svg)](https://github.com/gazebosim/gz-sim/issues)
[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/gazebosim/gz-sim.svg)](https://github.com/gazebosim/gz-sim/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-gazebo/branch/main/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-gazebo)
Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-sim/branch/main/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-sim)
Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_gazebo-ci-main-focal-amd64)](https://build.osrfoundation.org/job/ignition_gazebo-ci-main-focal-amd64)
Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_gazebo-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_gazebo-ci-main-homebrew-amd64)
Windows | [![Build Status](https://build.osrfoundation.org/job/ign_gazebo-ci-win/badge/icon)](https://build.osrfoundation.org/job/ign_gazebo-ci-win/)

Ignition Gazebo is an open source robotics simulator. Through Ignition Gazebo, users have access to high fidelity physics, rendering, and sensor models. Additionally, users and developers have multiple points of entry to simulation including a graphical user interface, plugins, and asynchronous message passing and services.
Gazebo Sim is an open source robotics simulator. Through Gazebo, users have access to high fidelity physics, rendering, and sensor models. Additionally, users and developers have multiple points of entry to simulation including a graphical user interface, plugins, and asynchronous message passing and services.

Ignition Gazebo is derived from [Gazebo](http://gazebosim.org) and represents over 16 years of development and experience in robotics and simulation. This library is part of the [Ignition Robotics](https://ignitionrobotics.org) project.
Gazebo Sim is derived from [Gazebo](http://gazebosim.org) and represents over 16 years of development and experience in robotics and simulation. This library is part of the [Gazebo](https://gazebosim.org) project.

# Table of Contents

Expand Down Expand Up @@ -44,45 +44,45 @@ Ignition Gazebo is derived from [Gazebo](http://gazebosim.org) and represents ov

* **Dynamics simulation**: Access multiple high-performance physics engines
through
[Ignition Physics](https://github.com/ignitionrobotics/ign-physics).
[Gazebo Physics](https://github.com/gazebosim/gz-physics).

* **Advanced 3D graphics**: Through
[Ignition Rendering](https://github.com/ignitionrobotics/ign-rendering),
[Gazebo Rendering](https://github.com/gazebosim/gz-rendering),
it's possible to use rendering engines such as OGRE v2 for realistic rendering
of environments with high-quality lighting, shadows, and textures.

* **Sensors and noise models**: Generate sensor data, optionally with noise,
from laser range finders, 2D/3D cameras, Kinect style sensors, contact sensors,
force-torque, IMU, GPS, and more, all powered by
[Ignition Sensors](https://github.com/ignitionrobotics/ign-sensors)
[Gazebo Sensors](https://github.com/gazebosim/gz-sensors)

* **Plugins**: Develop custom plugins for robot, sensor, and
environment control.

* **Graphical interface**: Create, instrospect and interact with your simulations
through plugin-based graphical interfaces powered by
[Ignition GUI](https://github.com/ignitionrobotics/ign-gui).
[Gazebo GUI](https://github.com/gazebosim/gz-gui).

* **Simulation models**: Access numerous robots including PR2, Pioneer2 DX,
iRobot Create, and TurtleBot, and construct environments using other physically
accurate models available through
[Ignition Fuel](https://app.ignitionrobotics.org/fuel). You can also build a
[Gazebo Fuel](https://app.gazebosim.org/fuel). You can also build a
new model using [SDF](http://sdformat.org).

* **TCP/IP Transport**: Run simulation on remote servers and interface to Ignition
Gazebo through socket-based message passing using
[Ignition Transport](https://github.com/ignitionrobotics/ign-transport).
Gazebo Sim through socket-based message passing using
[Gazebo Transport](https://github.com/gazebosim/gz-transport).

* **Command line tools**: Extensive command line tools for increased simulation
introspection and control.

# Install

See the [installation tutorial](https://ignitionrobotics.org/api/gazebo/6.1/install.html).
See the [installation tutorial](https://gazebosim.org/api/gazebo/6.1/install.html).

# Usage

Gazebo can be run from the command line, once [installed](#install), using:
Gazebo Sim can be run from the command line, once [installed](#install), using:

```
ign gazebo
Expand All @@ -100,10 +100,10 @@ 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,
`GZ_CONFIG_PATH` to point to the location of the Ignition library installation,
where the YAML file for the package is found, such as
```
export IGN_CONFIG_PATH=/usr/local/share/ignition
export GZ_CONFIG_PATH=/usr/local/share/ignition
```

However, that environment variable only takes a single path, which means if the
Expand All @@ -118,20 +118,20 @@ ln -s /usr/local/share/ignition/fuel8.yaml .
ln -s /usr/local/share/ignition/transport12.yaml .
ln -s /usr/local/share/ignition/transportlog12.yaml .
...
export IGN_CONFIG_PATH=$HOME/.ignition/tools/configs
export GZ_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

See the [installation tutorial](https://ignitionrobotics.org/api/gazebo/6.1/install.html).
See the [installation tutorial](https://gazebosim.org/api/gazebo/6.1/install.html).

# Testing

See the [installation tutorial](https://ignitionrobotics.org/api/gazebo/6.1/install.html).
See the [installation tutorial](https://gazebosim.org/api/gazebo/6.1/install.html).

See the [Writing Tests section of the contributor guide](https://github.com/ignitionrobotics/ign-gazebo/blob/main/CONTRIBUTING.md#writing-tests) for help creating or modifying tests.
See the [Writing Tests section of the contributor guide](https://github.com/gazebosim/gz-sim/blob/main/CONTRIBUTING.md#writing-tests) for help creating or modifying tests.

# Folder Structure

Expand Down Expand Up @@ -163,17 +163,17 @@ ign-gazebo
# Contributing

Please see
[CONTRIBUTING.md](https://github.com/ignitionrobotics/ign-gazebo/blob/main/CONTRIBUTING.md).
[CONTRIBUTING.md](https://github.com/gazebosim/gz-sim/blob/main/CONTRIBUTING.md).

# 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-sim/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-gazebo/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-sim/blob/main/LICENSE) file.
10 changes: 5 additions & 5 deletions api.md.in
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## Ignition @IGN_DESIGNATION_CAP@

Ignition @IGN_DESIGNATION_CAP@ is a component in Ignition Robotics, a set of libraries
Ignition @IGN_DESIGNATION_CAP@ is a component in Gazebo, a set of libraries
designed to rapidly develop robot and simulation applications.

**Useful links**

1. ignition::gazebo::components : List of built-in Component types. Components represent data, such as position information, that can be added to an Entity.
2. ignition::gazebo::systems : List of available Systems. A System operates on Entities that have a specific set of Components.
3. ignition::gazebo::events : List of simulation events. See the
ignition::gazebo::EventManager for details about events and how to use them.
1. gz::sim::components : List of built-in Component types. Components represent data, such as position information, that can be added to an Entity.
2. gz::sim::systems : List of available Systems. A System operates on Entities that have a specific set of Components.
3. gz::sim::events : List of simulation events. See the
gz::sim::EventManager for details about events and how to use them.

## License

Expand Down
Loading