Skip to content

Commit 5d29eb0

Browse files
author
Murilo Marinho
committed
Splitting installation to another file
1 parent cf3bf85 commit 5d29eb0

File tree

3 files changed

+51
-49
lines changed

3 files changed

+51
-49
lines changed

docs/README.md

Lines changed: 1 addition & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -4,55 +4,7 @@
44

55
If being read on GitHub, please note that this page is better seen at https://smartarmstack.github.io.
66

7-
## Installation
8-
9-
### Dependencies
10-
11-
#### ROS 2 Jazzy
12-
13-
You can refer to the official documentation at https://docs.ros.org/en/jazzy/Installation/Ubuntu-Install-Debs.html
14-
15-
#### DQ Robotics Development Version
16-
17-
```{seealso}
18-
More information at http://doi.org/10.1109/MRA.2020.2997920.
19-
```
20-
21-
```commandline
22-
sudo add-apt-repository ppa:dqrobotics-dev/development
23-
sudo apt-get update
24-
sudo apt-get install libdqrobotics libdqrobotics-interface-json11 libdqrobotics-interface-coppeliasim libdqrobotics-interface-coppeliasim-zmq
25-
```
26-
27-
### Set up PPA
28-
29-
This will add the `SAS` repository to your `apt` sources.
30-
31-
```commandline
32-
curl -s --compressed "https://smartarmstack.github.io/smart_arm_stack_ROS2/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/smartarmstack_lgpl.gpg >/dev/null
33-
sudo curl -s --compressed -o /etc/apt/sources.list.d/smartarmstack_lgpl.list "https://smartarmstack.github.io/smart_arm_stack_ROS2/smartarmstack_lgpl.list"
34-
sudo apt update
35-
```
36-
37-
### Installation
38-
39-
```{important}
40-
At this stage, `ROS2` must be installed otherwise dependencies might not be found correctly.
41-
```
42-
43-
The command below will install all `SAS` packages.
44-
45-
```commandline
46-
sudo apt-get install ros-jazzy-sas-*
47-
```
48-
49-
## Update
50-
51-
The `SAS` packages will update together with your other `apt` packages.
52-
53-
```commandline
54-
sudo apt-get update
55-
```
7+
## Quickstart
568

579

5810

docs/installation.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Installation
2+
3+
## Dependencies
4+
5+
### ROS 2 Jazzy
6+
7+
You can refer to the official documentation at https://docs.ros.org/en/jazzy/Installation/Ubuntu-Install-Debs.html
8+
9+
### DQ Robotics Development Version
10+
11+
```{seealso}
12+
More information at http://doi.org/10.1109/MRA.2020.2997920.
13+
```
14+
15+
```commandline
16+
sudo add-apt-repository ppa:dqrobotics-dev/development
17+
sudo apt-get update
18+
sudo apt-get install libdqrobotics libdqrobotics-interface-json11 libdqrobotics-interface-coppeliasim libdqrobotics-interface-coppeliasim-zmq
19+
```
20+
21+
### Set up PPA
22+
23+
This will add the `SAS` repository to your `apt` sources.
24+
25+
```commandline
26+
curl -s --compressed "https://smartarmstack.github.io/smart_arm_stack_ROS2/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/smartarmstack_lgpl.gpg >/dev/null
27+
sudo curl -s --compressed -o /etc/apt/sources.list.d/smartarmstack_lgpl.list "https://smartarmstack.github.io/smart_arm_stack_ROS2/smartarmstack_lgpl.list"
28+
sudo apt update
29+
```
30+
31+
### Installation
32+
33+
```{important}
34+
At this stage, `ROS2` must be installed otherwise dependencies might not be found correctly.
35+
```
36+
37+
The command below will install all `SAS` packages.
38+
39+
```commandline
40+
sudo apt-get install ros-jazzy-sas-*
41+
```
42+
43+
### Update
44+
45+
The `SAS` packages will update together with your other `apt` packages.
46+
47+
```commandline
48+
sudo apt-get update
49+
```

docs/myst.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ project:
2323
id: CC-BY-NC-SA-4.0
2424
toc:
2525
- file: README.md
26+
- file: installation.md
2627
- file: tutorial.md
2728
- file: CHANGELOG.md
2829

0 commit comments

Comments
 (0)