From c48be882805d4e3f6c901e4f52cf93ff52924894 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Thu, 13 Aug 2020 12:16:35 +0200 Subject: [PATCH 1/3] Removed repeated installation instructions Signed-off-by: ahcorde --- README.md | 23 +---------------------- tutorials/02_installation.md | 8 +++++--- 2 files changed, 6 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index fd6f9aa2f..70254799a 100644 --- a/README.md +++ b/README.md @@ -59,28 +59,7 @@ combination of custom code and ZeroMQ. # Install -We recommend following the [Binary Install](#markdown-header-binary-install) -instructions to get up and running as quickly and painlessly as possible. - -The [Source Install](#markdown-header-source-install) instructions should be -used if you need the very latest software improvements, you need to modify the -code, or you plan to make a contribution. - -## Binary Install - -On Ubuntu systems, `apt-get` can be used to install `ignition-transport`: - -``` -$ sudo apt install libignition-transport<#>-dev -``` - -Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on -which version you need. - -## Source Install - -See the [install](https://ignitionrobotics.org/api/transport/8.0/installation.html) -section of the documentation. +Review the [tutorial section](tutorials/02_installation.md). # Usage diff --git a/tutorials/02_installation.md b/tutorials/02_installation.md index a33839d28..0f915e3e2 100644 --- a/tutorials/02_installation.md +++ b/tutorials/02_installation.md @@ -25,13 +25,15 @@ Setup keys: wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add - ``` -Install Ignition Transport: +Install Ignition Transport, `apt-get` can be used to install `ignition-transport`: ``` -sudo apt-get update -sudo apt-get install libignition-transport9-dev +$ sudo apt install libignition-transport<#>-dev ``` +Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on +which version you need. + ## Mac OS X Ignition Transport and several of its dependencies can be compiled on OS From 5de434619f4e4afba954df4b0c775b8531d1f01e Mon Sep 17 00:00:00 2001 From: ahcorde Date: Fri, 14 Aug 2020 10:23:54 +0200 Subject: [PATCH 2/3] Updated install link Signed-off-by: ahcorde --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 70254799a..3d60932cd 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ combination of custom code and ZeroMQ. # Install -Review the [tutorial section](tutorials/02_installation.md). +Review the [tutorial section](https://ignitionrobotics.org/api/transport/9.0/installation.html). # Usage From 96d20871e530c91116a3369c8b67df8b731ad12b Mon Sep 17 00:00:00 2001 From: Louise Poubel Date: Fri, 14 Aug 2020 18:05:43 -0700 Subject: [PATCH 3/3] Wording tweak Signed-off-by: Louise Poubel --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3d60932cd..8ebf04b52 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ combination of custom code and ZeroMQ. # Install -Review the [tutorial section](https://ignitionrobotics.org/api/transport/9.0/installation.html). +See the [installation tutorial](https://ignitionrobotics.org/api/transport/9.0/installation.html). # Usage