From c398926c78152bcb12d9fc96262e00ce2247672f Mon Sep 17 00:00:00 2001 From: ahcorde Date: Thu, 13 Aug 2020 12:06:18 +0200 Subject: [PATCH 1/4] Removed repeated installation instructions Signed-off-by: ahcorde --- README.md | 69 +------------------------------------- tutorials/01_install.md | 74 +++++++++++++++++++++++++++++++++++++++-- 2 files changed, 73 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index 9a498570c..cee6fc696 100644 --- a/README.md +++ b/README.md @@ -27,14 +27,6 @@ which can be used to add custom widgets. [Install](#install) -* [Binary Install](#binary-install) - -* [Source Install](#source-install) - - * [Prerequisites](#prerequisites) - - * [Building from Source](#building-from-source) - [Usage](#usage) [Documentation](#documentation) @@ -60,66 +52,7 @@ which can be used to add custom widgets. # 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, if you need to modify the code, or if you plan to make a contribution. - -## Binary Install - -On Ubuntu Bionic, it's possible to install Ignition GUI's version 1 as follows: - -Add OSRF packages: - - echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list - echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-prerelease `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-prerelease.list - sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys D2486D2DD83DB69272AFE98867170598AF249743 - sudo apt update - -Install Ignition GUI: - - sudo apt install libignition-gui4-dev - -## Source Install - -There are currently two versions under active development: - -* **Version 0**: It makes use of `QWidgets`, which are common on traditional - desktop-oriented interfaces. Requires Ubuntu Xenial or Higher. - -* **Version 1**: It makes use of `QtQuick`, which allows developing more - modern-looking apps with animations and a mobile/web feel. Requires Ubuntu - Bionic or higher. - -### Prerequisites - -#### Ubuntu Bionic 18.04 or above - -Install dependencies: - - sudo apt update - sudo apt -y install wget lsb-release gnupg - sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list' - sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-prerelease `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-prerelease.list' - wget http://packages.osrfoundation.org/gazebo.key -O - | apt-key add - - 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-gui4 - 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 - -Clone source code: - - # This checks out the `default` branch. You can append `-b ign-gui#` (replace # with a number) to checkout a specific version - git clone http://github.com/ignitionrobotics/ign-gui - -### Building from source - -Build and install as follows: - - cd ign-gui - mkdir build - cd build - cmake .. - make -j4 - sudo make install +Review the [tutorial section](tutorials/01_install.md). # Usage diff --git a/tutorials/01_install.md b/tutorials/01_install.md index ca97711cb..9e7f8d238 100644 --- a/tutorials/01_install.md +++ b/tutorials/01_install.md @@ -2,5 +2,75 @@ Next Tutorial: \ref commandline -Refer to [Ignition GUI's entry page](https://ignitionrobotics.org/libs/gui) -for install instructions. +[Install](#install) + +* [Binary Install](#binary-install) + +* [Source Install](#source-install) + + * [Prerequisites](#prerequisites) + + * [Building from Source](#building-from-source) + +# 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, if you need to modify the code, or if you plan to make a contribution. + +## Binary Install + +On Ubuntu Bionic, it's possible to install Ignition GUI's version 1 as follows: + +Add OSRF packages: + + echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list + echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-prerelease `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-prerelease.list + sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys D2486D2DD83DB69272AFE98867170598AF249743 + sudo apt update + +Install Ignition GUI: + + sudo apt install libignition-gui4-dev + +## Source Install + +There are currently two versions under active development: + +* **Version 0**: It makes use of `QWidgets`, which are common on traditional + desktop-oriented interfaces. Requires Ubuntu Xenial or Higher. + +* **Version 1**: It makes use of `QtQuick`, which allows developing more + modern-looking apps with animations and a mobile/web feel. Requires Ubuntu + Bionic or higher. + +### Prerequisites + +#### Ubuntu Bionic 18.04 or above + +Install dependencies: + + sudo apt update + sudo apt -y install wget lsb-release gnupg + sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list' + sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-prerelease `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-prerelease.list' + wget http://packages.osrfoundation.org/gazebo.key -O - | apt-key add - + 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-gui4 + 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 + +Clone source code: + + # This checks out the `default` branch. You can append `-b ign-gui#` (replace # with a number) to checkout a specific version + git clone http://github.com/ignitionrobotics/ign-gui + +### Building from source + +Build and install as follows: + + cd ign-gui + mkdir build + cd build + cmake .. + make -j4 + sudo make install From 3cf7aee0f431ee5e0d9ecdbc58cb1ebf2e49689d Mon Sep 17 00:00:00 2001 From: ahcorde Date: Fri, 14 Aug 2020 09:52:32 +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 cee6fc696..99c412150 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ which can be used to add custom widgets. # Install -Review the [tutorial section](tutorials/01_install.md). +Review the [tutorial section](https://ignitionrobotics.org/api/gui/3.2/install.html). # Usage From d92e185735f845ab18152a205f866b8769c44636 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Mon, 17 Aug 2020 09:17:53 +0200 Subject: [PATCH 3/4] Updated install instructions Signed-off-by: ahcorde --- README.md | 2 +- tutorials/01_install.md | 12 +++++------- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 99c412150..4727533e3 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ which can be used to add custom widgets. # Install -Review the [tutorial section](https://ignitionrobotics.org/api/gui/3.2/install.html). +See the [installation tutorial](https://ignitionrobotics.org/api/gui/3.2/install.html). # Usage diff --git a/tutorials/01_install.md b/tutorials/01_install.md index 9e7f8d238..6691b8037 100644 --- a/tutorials/01_install.md +++ b/tutorials/01_install.md @@ -20,26 +20,25 @@ The [Source Install](#source-install) instructions should be used if you need th ## Binary Install -On Ubuntu Bionic, it's possible to install Ignition GUI's version 1 as follows: +On Ubuntu Bionic, it's possible to install Ignition GUI as follows: Add OSRF packages: echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list - echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-prerelease `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-prerelease.list sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys D2486D2DD83DB69272AFE98867170598AF249743 sudo apt update Install Ignition GUI: - sudo apt install libignition-gui4-dev + sudo apt install libignition-gui<#>-dev + +Be sure to replace `<#>` with a number value, such as 1 or 2, depending on +which version you need. ## Source Install There are currently two versions under active development: -* **Version 0**: It makes use of `QWidgets`, which are common on traditional - desktop-oriented interfaces. Requires Ubuntu Xenial or Higher. - * **Version 1**: It makes use of `QtQuick`, which allows developing more modern-looking apps with animations and a mobile/web feel. Requires Ubuntu Bionic or higher. @@ -53,7 +52,6 @@ Install dependencies: sudo apt update sudo apt -y install wget lsb-release gnupg sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list' - sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-prerelease `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-prerelease.list' wget http://packages.osrfoundation.org/gazebo.key -O - | apt-key add - 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-gui4 From c1dfaba4a029d18f227c298816e5fd5a7c87e38f Mon Sep 17 00:00:00 2001 From: ahcorde Date: Tue, 18 Aug 2020 08:41:46 +0200 Subject: [PATCH 4/4] Update docs Signed-off-by: ahcorde --- tutorials/01_install.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/tutorials/01_install.md b/tutorials/01_install.md index 6691b8037..0fbf83493 100644 --- a/tutorials/01_install.md +++ b/tutorials/01_install.md @@ -20,7 +20,7 @@ The [Source Install](#source-install) instructions should be used if you need th ## Binary Install -On Ubuntu Bionic, it's possible to install Ignition GUI as follows: +On Ubuntu, it's possible to install Ignition GUI as follows: Add OSRF packages: @@ -37,12 +37,6 @@ which version you need. ## Source Install -There are currently two versions under active development: - -* **Version 1**: It makes use of `QtQuick`, which allows developing more - modern-looking apps with animations and a mobile/web feel. Requires Ubuntu - Bionic or higher. - ### Prerequisites #### Ubuntu Bionic 18.04 or above @@ -59,7 +53,7 @@ Install dependencies: Clone source code: - # This checks out the `default` branch. You can append `-b ign-gui#` (replace # with a number) to checkout a specific version + # This checks out the `master` branch. You can append `-b ign-gui#` (replace # with a number) to checkout a specific version git clone http://github.com/ignitionrobotics/ign-gui ### Building from source