diff --git a/README.md b/README.md index c126e96f5..260cb6d79 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ -# Ignition Transport +# Gazebo Transport **Maintainer:** caguero AT openrobotics DOT org -[![GitHub open issues](https://img.shields.io/github/issues-raw/ignitionrobotics/ign-transport.svg)](https://github.com/ignitionrobotics/ign-transport/issues) -[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/ignitionrobotics/ign-transport.svg)](https://github.com/ignitionrobotics/ign-transport/pulls) +[![GitHub open issues](https://img.shields.io/github/issues-raw/gazebosim/gz-transport.svg)](https://github.com/gazebosim/gz-transport/issues) +[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/gazebosim/gz-transport.svg)](https://github.com/gazebosim/gz-transport/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-transport/branch/ign-transport8/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-transport) -Ubuntu Bionic | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_transport-ci-ign-transport8-bionic-amd64)](https://build.osrfoundation.org/job/ignition_transport-ci-ign-transport8-bionic-amd64) +Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-transport/branch/ign-transport8/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-transport/branch/ign-transport8) +Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_transport-ci-ign-transport8-focal-amd64)](https://build.osrfoundation.org/job/ignition_transport-ci-ign-transport8-focal-amd64) Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_transport-ci-ign-transport8-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_transport-ci-ign-transport8-homebrew-amd64) -Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_transport-ci-ign-transport8-windows7-amd64)](https://build.osrfoundation.org/job/ignition_transport-ci-ign-transport8-windows7-amd64) +Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ign_transport-ign-8-win)](https://build.osrfoundation.org/job/ign_transport-ign-8-win) -Ignition Transport, a component of [Ignition Robotics](https://ignitionrobotics.org), provides fast and efficient asyncronous message passing, services, and data logging. +Gazebo Transport, a component of [Gazebo](https://gazebosim.org), provides fast and efficient asynchronous message passing, services, and data logging. # Table of Contents @@ -40,16 +40,16 @@ Ignition Transport, a component of [Ignition Robotics](https://ignitionrobotics. # Features -Ignition Transport is an open source communication library that allows +Gazebo Transport is an open source communication library that allows exchanging data between clients. In our context, a client is called a node. Nodes might be running within the same process in the same machine or in -machines located in different continents. Ignition Transport is multi-platform +machines located in different continents. Gazebo Transport is multi-platform (Linux, Mac OS X, and Windows), so all the low level details, such as data alignment or endianness are hidden for you. -Ignition Transport uses Google Protocol buffers as the data serialization format +Gazebo Transport uses Google Protocol buffers as the data serialization format for communicating between nodes. Users can define their own messages using the -Protobuf utils, and then, exchange them between the nodes. Ignition Transport +Protobuf utils, and then, exchange them between the nodes. Gazebo Transport discovers, serializes and delivers messages to the destinations using a combination of custom code and ZeroMQ. @@ -75,13 +75,13 @@ which version you need. ## Source Install -See the [install](https://ignitionrobotics.org/api/transport/8.0/installation.html) +See the [install](https://gazebosim.org/api/transport/8.0/installation.html) section of the documentation. # Usage -See [tutorials](https://ignitionrobotics.org/api/transport/8.0/tutorials.html) -and the [example directory](https://github.com/ignitionrobotics/ign-transport/blob/ign-transport8/example/) +See [tutorials](https://gazebosim.org/api/transport/8.0/tutorials.html) +and the [example directory](https://github.com/gazebosim/gz-transport/blob/ign-transport8/example/) in the source code. ## Known issue of command line tools @@ -90,7 +90,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 @@ -99,7 +99,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 @@ -111,46 +111,46 @@ 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 -Visit the [documentation page](https://ignitionrobotics.org/api/transport/8.0/index.html). +Visit the [documentation page](https://gazebosim.org/api/transport/8.0/index.html). # Folder Structure ``` -ign-transport +gz-transport ├── conf Configuration file for the integration with the `ign` CLI tool. -├── example Example programs that use most of the Ignition Transport API. +├── example Example programs that use most of the Gazebo Transport API. ├── include Header files that get installed. -├── log All the code related with Ignition Transport logging. +├── log All the code related with Gazebo Transport logging. ├── src Source code of the core library. ├── test A directory of integration, performance and regression tests. ├── tools Scripts for continuous integration testing. -└── tutorials A set of tutorials about Ignition Transport features. +└── tutorials A set of tutorials about Gazebo Transport features. ``` # Contributing -Please see -[CONTRIBUTING.md](https://github.com/ignitionrobotics/ign-gazebo/blob/main/CONTRIBUTING.md). +Please see the +[contributing gude](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-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) +this library is part of the [Gazebo project](https://gazebosim.org) which periodically releases a versioned set of compatible and complimentary -libraries. See the [Ignition Robotics website](https://ignitionrobotics.org) for +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-transport/raw/main/LICENSE) +See also the [LICENSE](https://github.com/gazebosim/gz-transport/raw/main/LICENSE) file.