Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to installation documentation #416

Merged
merged 4 commits into from
Sep 7, 2022
Merged

Updates to installation documentation #416

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5559568
Updates in installation documentation for gz-physics6.
JoanAguilar Sep 7, 2022
1c63ecc
Merge branch 'gz-physics6' into joanaguilar/garden-tutorial/installat…
mjcarroll Sep 7, 2022
88b8ada
Provide old version numbers.
JoanAguilar Sep 7, 2022
e7798ed
Reword note about older versions.
JoanAguilar Sep 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions tutorials/02_installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ The Source Installation instructions are generally recommended for developers wh

Ubuntu Focal or later.

If you don't already have the `lsb-release` package installed, please do so now:
If you don't already have the packages `gnupg`, `lsb-release`, or `wget` installed, please do so now:
```
sudo apt-get update
sudo apt-get install lsb-release
sudo apt-get install gnupg lsb-release wget
```

Setup your computer to accept software from
Expand Down Expand Up @@ -44,15 +44,17 @@ Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on w
1. Install dependencies
```
sudo apt-add-repository -s "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -c -s) main"
sudo apt-get build-dep -y gz-physics<#>-dev
sudo apt-get build-dep -y libgz-physics<#>-dev
```
Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need.
Be sure to replace `<#>` with a number value, such as `5` or `6`, depending on which version you need.
Older versions can be installed by using the `libignition-physics<#>-dev` packages.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we specify which are the older versions?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

88b8ada


2. Clone the repository
```
git clone https://github.com/gazebosim/gz-physics -b ign-physics<#>
git clone https://github.com/gazebosim/gz-physics -b gz-physics<#>
```
Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need.
Be sure to replace `<#>` with a number value, such as `5` or `6`, depending on which version you need.
Older versions can be cloned from the `ign-physics<#>` branches.

3. Configure and build
```
Expand Down Expand Up @@ -225,7 +227,16 @@ Follow these steps to run tests and static code analysis in your clone of this r
make test
```

3. Static code checker.
3. You will need Cppcheck in order to run static code checks. On Ubuntu Cppcheck can be installed using
```
sudo apt-get install cppcheck
```

4. Configure and run the static code checker.
```
cd gz-physics
mkdir build
cd build
cmake ..
make codecheck
```