@@ -28,19 +28,19 @@ Please note that `sas` is originally based on developments [circa 2013](https://
2828Affiliation with the University of Tokyo has ceased on December 2023 and this project is currently affiliated with
2929the University of Manchester.
3030
31- ## Quickstart
32-
33- ### Docker
31+ ## Docker
3432[ ![ Docker Pulls] ( https://img.shields.io/docker/pulls/murilomarinho/sas )] ( https://hub.docker.com/r/murilomarinho/sas )
3533
3634``` commandline
3735docker run -it murilomarinho/sas:jazzy
3836```
3937
40- ### Installation
38+ ## Installation
4139[ ![ 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 )
4240
43- ``` {tip}
41+ ### Pre-requisites
42+
43+ ``` {note}
4444:class: dropdown
4545#### Click here for the pre-requisites
4646
@@ -75,6 +75,13 @@ python3 -m pip install dqrobotics --pre --break-system-packages
7575:::
7676
7777```
78+
79+ ### LGPL Packages
80+
81+ :::{tip}
82+ The LGPL packages are available in ` amd64 ` and ` arm64 ` .
83+ :::
84+
7885The command below will add and install the ` sas ` LGPL packages via ` apt-get ` .
7986
8087``` bash
@@ -87,45 +94,8 @@ sudo apt update
8794sudo apt-get install ros-jazzy-sas-*
8895```
8996
90- The command below will add and install the ` sas ` CC BY-NC 4.0 packages via ` apt-get ` . Please note that they depend on ` sas ` LGPL packages.
91-
92- :::{important}
93- These CC BY-NC 4.0 packages are currently only available in ` amd64 ` owing to GitHub limitations in private repositories.
94- :::
95-
96- ``` bash
97- curl -s --compressed " https://marinholab.github.io/sas_debian_builder_noncommercial/KEY.gpg" \
98- | gpg --dearmor \
99- | sudo tee /etc/apt/trusted.gpg.d/smartarmstack_cc_by_nc.gpg > /dev/null
100- sudo curl -s --compressed -o /etc/apt/sources.list.d/smartarmstack_cc_by_nc.list \
101- " https://marinholab.github.io/sas_debian_builder_noncommercial/smartarmstack_cc_by_nc.list"
102- sudo apt update
103- sudo apt-get install ros-jazzy-sas-*
104- ```
105-
10697``` {note}
10798:class: dropdown
108- # Click here for update instructions
109- After installing the packages with the command above, you can update them with
110- :::bash
111- sudo apt-get update && sudo apt-get upgrade ros-jazzy-sas-*
112- :::
113- ```
114-
115- ## License
116-
117- ``` {figure} img/computer_ros2.png
118- :label: sas_and_ros2
119- :width: 300px
120- :align: left
121-
122- SAS and ROS2
123- ```
124-
125- ` sas ` has worked in a dual-licensing scheme, described in the dropdown boxes below.
126-
127- ``` {important}
128- :class: dropdown
12999### Click here for the LGPL packages information
130100
131101Copyright (C) 2025 Murilo M. Marinho.
@@ -143,7 +113,25 @@ Copyright (C) 2025 Murilo M. Marinho.
143113| `sas_robot_driver_ur` | LGPL | A `sas_robot_driver` implementation for UR |
144114```
145115
146- ``` {tip}
116+ ### CC BY-NC 4.0 Packages
117+
118+ :::{tip}
119+ The CC BY-NC 4.0 packages are currently only available in ` amd64 ` owing to GitHub limitations in private repositories.
120+ :::
121+
122+ The command below will add and install the ` sas ` CC BY-NC 4.0 packages via ` apt-get ` . Please note that they depend on ` sas ` LGPL packages.
123+
124+ ``` bash
125+ curl -s --compressed " https://marinholab.github.io/sas_debian_builder_noncommercial/KEY.gpg" \
126+ | gpg --dearmor \
127+ | sudo tee /etc/apt/trusted.gpg.d/smartarmstack_cc_by_nc.gpg > /dev/null
128+ sudo curl -s --compressed -o /etc/apt/sources.list.d/smartarmstack_cc_by_nc.list \
129+ " https://marinholab.github.io/sas_debian_builder_noncommercial/smartarmstack_cc_by_nc.list"
130+ sudo apt update
131+ sudo apt-get install ros-jazzy-sas-*
132+ ```
133+
134+ ``` {note}
147135:class: dropdown
148136### Click here for the CC BY-NC 4.0 packages information
149137
@@ -157,6 +145,26 @@ Commercial licensing available by contacting contact@uominnovationfactory.com.
157145| `sas_robot_kinematics_constrained_multiarm` | CC BY-NC 4.0 | A centralised solver for multiple robots with configurable vector-field inequalities. |
158146```
159147
148+ ### Updates
149+
150+ After installing the packages with the command above, you can update them with
151+
152+ ::: bash
153+ sudo apt-get update && sudo apt-get upgrade ros-jazzy-sas-*
154+ :::
155+
156+ ## License
157+
158+ ``` {figure} img/computer_ros2.png
159+ :label: sas_and_ros2
160+ :width: 300px
161+ :align: left
162+
163+ SAS and ROS2
164+ ```
165+
166+ ` sas ` has worked in a dual-licensing scheme, described in the dropdown boxes below.
167+
160168## Tutorials
161169
162170Please refer to https://ros2-tutorial.readthedocs.io/en/latest/sas/index.html .
0 commit comments