Skip to content

Commit 05e5d93

Browse files
author
Murilo Marinho
committed
[README] Adding pre-requisites as a dropdox, move information to cards.
1 parent e4f5181 commit 05e5d93

File tree

3 files changed

+62
-45
lines changed

3 files changed

+62
-45
lines changed

docs/README.md

Lines changed: 62 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,41 @@ docker run -it murilomarinho/sas:latest
1515
### Installation
1616
[![SAS Debian Builder](https://github.com/SmartArmStack/smart_arm_stack_ROS2/actions/workflows/sas_debian_builder.yml/badge.svg?branch=jazzy)](https://github.com/SmartArmStack/smart_arm_stack_ROS2/actions/workflows/sas_debian_builder.yml)
1717

18-
> [!IMPORTANT]
19-
> See installation pre-requisites at https://smartarmstack.github.io/pre-requisites.
18+
```{tip}
19+
:class: dropdown
20+
#### Click here for the pre-requisites
21+
22+
#### ROS 2 Jazzy
23+
24+
- You can refer to the official documentation at https://docs.ros.org/en/jazzy/Installation/Ubuntu-Install-Debs.html
25+
- A softer explanation is available in https://ros2-tutorial.readthedocs.io/en/latest/installation.html.
26+
27+
#### DQ Robotics Development Version
28+
29+
##### C++
30+
31+
:::{important}
32+
The `development` version is needed.
33+
:::
34+
35+
:::commandline
36+
sudo add-apt-repository ppa:dqrobotics-dev/development
37+
sudo apt-get update
38+
sudo apt-get install libdqrobotics libdqrobotics-interface-json11 libdqrobotics-interface-coppeliasim libdqrobotics-interface-coppeliasim-zmq
39+
:::
40+
41+
##### Python
42+
43+
:::{important}
44+
Because ROS2 does not currently support `venv`, it is recommended
45+
to install this system-wide.
46+
:::
47+
48+
:::commandline
49+
python3 -m pip install dqrobotics --pre --break-system-packages
50+
:::
51+
52+
```
2053

2154

2255
The command below will add and install the `sas` packages via `apt-get`.
@@ -48,25 +81,40 @@ sudo apt-get install ros-jazzy-sas-*
4881
SAS and ROS2
4982
```
5083
51-
The SmartArmStack has been developed in support of the SmartArm robot described in http://doi.org/10.1002/rcs.2053.
52-
It has then been used in dozens of publications and updated in http://doi.org/10.1109/MRA.2023.3336472. Please cite one
53-
of these references if you use `SAS` in your own work.
84+
::::{grid} 1 1 2 3
85+
86+
:::{card}
87+
:header: Focus on your application🔍
88+
`SAS` is a C++ framework with Python bindings to enable fast prototyping on ROS 2.
89+
:::
5490

55-
The current version of `SAS` supports `ROS 2`.
91+
:::{card}
92+
:header: `ROS2` where it shines✨
93+
Split away `ROS 2` code into `client` and `server` classes, communicate via `ROS 2`
94+
without `ROS 2` code.
95+
:::
5696

57-
## About
97+
:::{card}
98+
:header: Multiple robots🤖
99+
Enjoy drivers for `DensoWave`, `UR`, and `KUKA`. With ongoing developments for `Franka Emika`
100+
and `Unitree` robots.
101+
:::
102+
::::
58103

59-
`SAS` is a C++ framework with Python bindings to enable fast prototyping on ROS 2. Focus on your application.
60-
The concept of `SAS` is to split away `ROS 2` code into `client` and `server` classes, allowing your code to use
61-
`ROS 2` interfaces without any need to create `publishers` or `subscribers` manually.
104+
105+
106+
107+
The SmartArmStack has been developed in support of the SmartArm robot described in http://doi.org/10.1002/rcs.2053.
108+
It has then been used in dozens of publications and updated in http://doi.org/10.1109/MRA.2023.3336472. Please cite one
109+
of these references if you use `SAS` in your own work.
62110

63111
## License
64112

65113
Most of the library is licensed in LGPLv3. Some packages are licensed as Research Only, with no commercial use allowed.
66114

67115
## Package Summary
68116

69-
*Research only* packages cannot be used for commercial use.
117+
### LGPL
70118

71119
| Package | License | Description |
72120
|--------------------------|---------|--------------------------------------------------------------------------------------------------------------------------|
@@ -88,7 +136,9 @@ Please refer to https://ros2-tutorial.readthedocs.io/en/latest/sas/index.html.
88136

89137
### LGPL
90138

91-
The PPA for the LGPL version is available at https://smartarmstack.github.io/smart_arm_stack_ROS2/. The archive is available at https://github.com/SmartArmStack/smart_arm_stack_ROS2/releases in case you need to rely on older versions.
139+
The PPA for the LGPL version is available at https://smartarmstack.github.io/smart_arm_stack_ROS2/.
140+
141+
The archive is available at https://github.com/SmartArmStack/smart_arm_stack_ROS2/releases in case you need to rely on older versions.
92142

93143
## Older versions
94144

docs/myst.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ project:
2323
id: CC-BY-NC-SA-4.0
2424
toc:
2525
- file: README.md
26-
- file: pre_requisites.md
2726
- title: "Modules"
2827
children:
2928
- file: submodules/sas_ur_control_template/sas_ur_control_template_README.md

docs/pre_requisites.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)