Skip to content

Document the supported installation in README #11

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

Merged
mmmarinho merged 1 commit into from
Sep 27, 2026
Merged

Document the supported installation in README #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,33 @@
> More information about SmartArmStack is available in
> [smartarmstack.github.io](https://smartarmstack.github.io/).

## Installation

The supported installation is the [SmartArmStack apt repository](https://smartarmstack.github.io/),
which provides the pre-built `libmarinholab-sas-core` package
(LGPL, `amd64` and `arm64`):

```bash
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
sudo curl -s --compressed -o /etc/apt/sources.list.d/smartarmstack_lgpl.list \
"https://smartarmstack.github.io/smart_arm_stack_ROS2/smartarmstack_lgpl.list"
sudo apt update
sudo apt-get install libmarinholab-sas-core
```

The package depends on `libdqrobotics` (from the DQ Robotics PPA, see
[Prerequisites](#prerequisites)) and installs the shared library, the
headers under `/usr/include/marinholab/sas/core/` and the CMake package
configuration, so consumers can `find_package(marinholab_sas_core)`.
Keep it up to date with
`sudo apt-get update && sudo apt-get upgrade libmarinholab-sas-core`.

Building from source is described in [Building (CMake)](#building-cmake);
the full list of SmartArmStack packages is on
[smartarmstack.github.io](https://smartarmstack.github.io/).

## Contents

- `include/marinholab/sas/core/` — public C++ headers
Expand Down
Loading