From 4886316b891532fa81af0f6e1bd63c0959c7322a Mon Sep 17 00:00:00 2001 From: ahcorde Date: Thu, 13 Aug 2020 12:12:00 +0200 Subject: [PATCH 1/4] Removed repeated installation instructions Signed-off-by: ahcorde --- README.md | 69 +----------------------------------- tutorials/02_installation.md | 51 ++++++++++++++++---------- 2 files changed, 34 insertions(+), 86 deletions(-) diff --git a/README.md b/README.md index 651385156..88e792f06 100644 --- a/README.md +++ b/README.md @@ -26,14 +26,6 @@ designed to support simulation and rapid development of robot applications. [Install](#install) -* [Binary Install](#binary-install) - -* [Source Install](#source-install) - - * [Prerequisites](#prerequisites) - - * [Building from Source](#building-from-source) - [Usage](#usage) [Documentation](#documentation) @@ -80,66 +72,7 @@ Ignition Physics provides the following functionality: # Install -We recommend following the [Binary Install](#binary-install) instructions to get up and running as quickly and painlessly as possible. - -The [Source Install](#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-physics3`: - -``` -sudo apt install libignition-physics3-dev -``` - -## Source Install - -Source installation can be performed in UNIX systems by first installing the -necessary prerequisites followed by building from source. - -### Prerequisites - -Install required dependencies: - -~~~ -sudo apt update -sudo apt-get -y install lsb-release -sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list' -apt-key adv --keyserver keyserver.ubuntu.com --recv-keys D2486D2DD83DB69272AFE98867170598AF249743 -sudo apt-add-repository -s "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -c -s) main" -sudo apt-get build-dep -y ignition-physics3 -~~~ - -Use gcc-8: - -~~~ -sudo apt update -sudo apt-get -y install g++-8 -sudo update-alternatives --install \ - /usr/bin/gcc gcc /usr/bin/gcc-8 800 \ - --slave /usr/bin/g++ g++ /usr/bin/g++-8 \ - --slave /usr/bin/gcov gcov /usr/bin/gcov-8 -~~~ - -### Building from source - -1. Clone the repository - - ``` - git clone https://github.com/ignitionrobotics/ign-physics -b master - ``` - -2. Configure and build - - ``` - cd ign-physics; mkdir build; cd build; cmake ..; make - ``` - -3. Optionally, install Ignition Physics - - ``` - sudo make install - ``` +Review the [tutorial section](tutorials/02_installation.md). # Usage diff --git a/tutorials/02_installation.md b/tutorials/02_installation.md index 3ddce045d..5707e4bec 100644 --- a/tutorials/02_installation.md +++ b/tutorials/02_installation.md @@ -36,26 +36,41 @@ sudo apt-get install libignition-physics3-dev **Build from source** -Run the following to install dependencies -```{.sh} -sudo apt-add-repository -s "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -c -s) main" -sudo apt-get build-dep -y ignition-physics3 -``` +1. Run the following to install dependencies -Clone the ign-physics repository from GitHub -```{.sh} -git clone https://github.com/ignitionrobotics/ign-physics -b master -``` + ```{.sh} + sudo apt-add-repository -s "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -c -s) main" + sudo apt-get build-dep -y ignition-physics3 + ``` -Then build using CMake -```{.sh} -cd ign-physics -mkdir build -cd build -cmake .. -make -sudo make install -``` +2. Use gcc-8: + + ``` + sudo apt update + sudo apt-get -y install g++-8 + sudo update-alternatives --install \ + /usr/bin/gcc gcc /usr/bin/gcc-8 800 \ + --slave /usr/bin/g++ g++ /usr/bin/g++-8 \ + --slave /usr/bin/gcov gcov /usr/bin/gcov-8 + ``` + +3. Clone the repository + + ``` + git clone https://github.com/ignitionrobotics/ign-physics -b master + ``` + +4. Configure and build + + ``` + cd ign-physics; mkdir build; cd build; cmake ..; make + ``` + +5. Optionally, install Ignition Physics + + ``` + sudo make install + ``` ## macOS From 34218d217356f764ea30ca35020abc2ca9d9c8df Mon Sep 17 00:00:00 2001 From: ahcorde Date: Fri, 14 Aug 2020 10:18:22 +0200 Subject: [PATCH 2/4] 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 88e792f06..c99214899 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ Ignition Physics provides the following functionality: # Install -Review the [tutorial section](tutorials/02_installation.md). +Review the [tutorial section](https://ignitionrobotics.org/api/physics/2.2/installation.html). # Usage From 697a7be52add07bffc16d000cadfef8f8ec5f874 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Mon, 17 Aug 2020 09:12:48 +0200 Subject: [PATCH 3/4] Improved install instructions Signed-off-by: ahcorde --- README.md | 2 +- tutorials/02_installation.md | 23 +++++++++++++++++------ 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c99214899..0d258b11b 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ Ignition Physics provides the following functionality: # Install -Review the [tutorial section](https://ignitionrobotics.org/api/physics/2.2/installation.html). +See the [installation tutorial](https://ignitionrobotics.org/api/physics/2.2/installation.html). # Usage diff --git a/tutorials/02_installation.md b/tutorials/02_installation.md index 5707e4bec..740aa762b 100644 --- a/tutorials/02_installation.md +++ b/tutorials/02_installation.md @@ -31,17 +31,21 @@ wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add - ```{.sh} sudo apt-get update -sudo apt-get install libignition-physics3-dev +sudo apt-get install libignition-physics<#>-dev ``` +Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need. + **Build from source** 1. Run the following to install dependencies ```{.sh} sudo apt-add-repository -s "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -c -s) main" - sudo apt-get build-dep -y ignition-physics3 + sudo apt-get build-dep -y ignition-physics<#>-dev ``` + Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need. + 2. Use gcc-8: @@ -57,8 +61,10 @@ sudo apt-get install libignition-physics3-dev 3. Clone the repository ``` - git clone https://github.com/ignitionrobotics/ign-physics -b master + git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics<#>-dev ``` + Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need. + 4. Configure and build @@ -94,21 +100,26 @@ Run the following commands: ```{.sh} brew tap osrf/simulation -brew install ignition-physics3 +brew install ignition-physics<#> ``` +Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need. + **Build from source using Homebrew** Run the following to install dependencies ```{.sh} brew tap osrf/simulation -brew install ignition-physics3 --only-dependencies +brew install ignition-physics<#> --only-dependencies ``` +Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need. + Clone the ign-physics repository from GitHub ```{.sh} -git clone https://github.com/ignitionrobotics/ign-physics -b master +git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics<#>-dev ``` +Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need. Then build using CMake ```{.sh} From c8b36990715166139af3a5b7474be388b6c8a839 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Tue, 25 Aug 2020 08:45:35 +0200 Subject: [PATCH 4/4] Fixed instructions Signed-off-by: ahcorde --- tutorials/02_installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tutorials/02_installation.md b/tutorials/02_installation.md index 740aa762b..d623031de 100644 --- a/tutorials/02_installation.md +++ b/tutorials/02_installation.md @@ -61,7 +61,7 @@ Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on w 3. Clone the repository ``` - git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics<#>-dev + git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics<#> ``` Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need. @@ -117,7 +117,7 @@ Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on w Clone the ign-physics repository from GitHub ```{.sh} -git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics<#>-dev +git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics<#> ``` Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need.