Skip to content

Commit 0be3a49

Browse files
authored
Ignition -> Gazebo (#330)
Signed-off-by: Jenn Nguyen <jenn@openrobotics.org>
1 parent 30da9d3 commit 0be3a49

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# Ignition Transport
1+
# Gazebo Transport
22

33
**Maintainer:** caguero AT openrobotics DOT org
44

5-
[![GitHub open issues](https://img.shields.io/github/issues-raw/ignitionrobotics/ign-transport.svg)](https://github.com/ignitionrobotics/ign-transport/issues)
6-
[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/ignitionrobotics/ign-transport.svg)](https://github.com/ignitionrobotics/ign-transport/pulls)
5+
[![GitHub open issues](https://img.shields.io/github/issues-raw/gazebosim/gz-transport.svg)](https://github.com/gazebosim/gz-transport/issues)
6+
[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/gazebosim/gz-transport.svg)](https://github.com/gazebosim/gz-transport/pulls)
77
[![Discourse topics](https://img.shields.io/discourse/https/community.gazebosim.org/topics.svg)](https://community.gazebosim.org)
88
[![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)](https://www.apache.org/licenses/LICENSE-2.0)
99

1010
Build | Status
1111
-- | --
12-
Test coverage | [![codecov](https://codecov.io/gh/ignitionrobotics/ign-transport/branch/ign-transport8/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-transport)
13-
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)
12+
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)
13+
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)
1414
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)
15-
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)
15+
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)
1616

17-
Ignition Transport, a component of [Ignition Robotics](https://ignitionrobotics.org), provides fast and efficient asyncronous message passing, services, and data logging.
17+
Gazebo Transport, a component of [Gazebo](https://gazebosim.org), provides fast and efficient asynchronous message passing, services, and data logging.
1818

1919
# Table of Contents
2020

@@ -40,16 +40,16 @@ Ignition Transport, a component of [Ignition Robotics](https://ignitionrobotics.
4040

4141
# Features
4242

43-
Ignition Transport is an open source communication library that allows
43+
Gazebo Transport is an open source communication library that allows
4444
exchanging data between clients. In our context, a client is called a node.
4545
Nodes might be running within the same process in the same machine or in
46-
machines located in different continents. Ignition Transport is multi-platform
46+
machines located in different continents. Gazebo Transport is multi-platform
4747
(Linux, Mac OS X, and Windows), so all the low level details, such as data
4848
alignment or endianness are hidden for you.
4949

50-
Ignition Transport uses Google Protocol buffers as the data serialization format
50+
Gazebo Transport uses Google Protocol buffers as the data serialization format
5151
for communicating between nodes. Users can define their own messages using the
52-
Protobuf utils, and then, exchange them between the nodes. Ignition Transport
52+
Protobuf utils, and then, exchange them between the nodes. Gazebo Transport
5353
discovers, serializes and delivers messages to the destinations using a
5454
combination of custom code and ZeroMQ.
5555

@@ -75,13 +75,13 @@ which version you need.
7575

7676
## Source Install
7777

78-
See the [install](https://ignitionrobotics.org/api/transport/8.0/installation.html)
78+
See the [install](https://gazebosim.org/api/transport/8.0/installation.html)
7979
section of the documentation.
8080

8181
# Usage
8282

83-
See [tutorials](https://ignitionrobotics.org/api/transport/8.0/tutorials.html)
84-
and the [example directory](https://github.com/ignitionrobotics/ign-transport/blob/ign-transport8/example/)
83+
See [tutorials](https://gazebosim.org/api/transport/8.0/tutorials.html)
84+
and the [example directory](https://github.com/gazebosim/gz-transport/blob/ign-transport8/example/)
8585
in the source code.
8686

8787
## 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
9090
line tools from `ign-tools` may not work correctly.
9191

9292
A workaround for a single package is to define the environment variable
93-
`IGN_CONFIG_PATH` to point to the location of the Ignition library installation,
93+
`IGN_CONFIG_PATH` to point to the location of the Gazebo library installation,
9494
where the YAML file for the package is found, such as
9595
```
9696
export IGN_CONFIG_PATH=/usr/local/share/ignition
@@ -99,7 +99,7 @@ export IGN_CONFIG_PATH=/usr/local/share/ignition
9999
However, that environment variable only takes a single path, which means if the
100100
installations from source are in different locations, only one can be specified.
101101

102-
Another workaround for working with multiple Ignition libraries on the command
102+
Another workaround for working with multiple Gazebo libraries on the command
103103
line is using symbolic links to each library's YAML file.
104104
```
105105
mkdir ~/.ignition/tools/configs -p
@@ -111,46 +111,46 @@ ln -s /usr/local/share/ignition/transportlog7.yaml .
111111
export IGN_CONFIG_PATH=$HOME/.ignition/tools/configs
112112
```
113113

114-
This issue is tracked [here](https://github.com/ignitionrobotics/ign-tools/issues/8).
114+
This issue is tracked [here](https://github.com/gazebosim/gz-tools/issues/8).
115115

116116
# Documentation
117117

118-
Visit the [documentation page](https://ignitionrobotics.org/api/transport/8.0/index.html).
118+
Visit the [documentation page](https://gazebosim.org/api/transport/8.0/index.html).
119119

120120
# Folder Structure
121121

122122
```
123-
ign-transport
123+
gz-transport
124124
├── conf Configuration file for the integration with the `ign` CLI tool.
125-
├── example Example programs that use most of the Ignition Transport API.
125+
├── example Example programs that use most of the Gazebo Transport API.
126126
├── include Header files that get installed.
127-
├── log All the code related with Ignition Transport logging.
127+
├── log All the code related with Gazebo Transport logging.
128128
├── src Source code of the core library.
129129
├── test A directory of integration, performance and regression tests.
130130
├── tools Scripts for continuous integration testing.
131-
└── tutorials A set of tutorials about Ignition Transport features.
131+
└── tutorials A set of tutorials about Gazebo Transport features.
132132
```
133133

134134
# Contributing
135135

136-
Please see
137-
[CONTRIBUTING.md](https://github.com/ignitionrobotics/ign-gazebo/blob/main/CONTRIBUTING.md).
136+
Please see the
137+
[contributing gude](https://gazebosim.org/docs/all/contributing).
138138

139139
# Code of Conduct
140140

141141
Please see
142-
[CODE_OF_CONDUCT.md](https://github.com/ignitionrobotics/ign-gazebo/blob/main/CODE_OF_CONDUCT.md).
142+
[CODE_OF_CONDUCT.md](https://github.com/gazebosim/gz-sim/blob/main/CODE_OF_CONDUCT.md).
143143

144144
# Versioning
145145

146146
This library uses [Semantic Versioning](https://semver.org/). Additionally,
147-
this library is part of the [Ignition Robotics project](https://ignitionrobotics.org)
147+
this library is part of the [Gazebo project](https://gazebosim.org)
148148
which periodically releases a versioned set of compatible and complimentary
149-
libraries. See the [Ignition Robotics website](https://ignitionrobotics.org) for
149+
libraries. See the [Gazebo website](https://gazebosim.org) for
150150
version and release information.
151151

152152
# License
153153

154154
This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
155-
See also the [LICENSE](https://github.com/ignitionrobotics/ign-transport/raw/main/LICENSE)
155+
See also the [LICENSE](https://github.com/gazebosim/gz-transport/raw/main/LICENSE)
156156
file.

0 commit comments

Comments
 (0)