Skip to content

Commit

Permalink
Update binary install instructions (#394)
Browse files Browse the repository at this point in the history
### Proposed changes

Closes #302. This patch updates binary installation instructions after
the recent Beluga release to most non-EOL'd ROS distributions (as of May
2024).

#### Type of change

- [ ] 🐛 Bugfix (change which fixes an issue)
- [ ] 🚀 Feature (change which adds functionality)
- [x] 📚 Documentation (change which fixes or extends documentation)

### Checklist

- [ ] Lint and unit tests (if any) pass locally with my changes
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [x] I have added necessary documentation (if appropriate)
- [x] All commits have been signed for
[DCO](https://developercertificate.org/)

---------

Signed-off-by: Michel Hidalgo <[email protected]>
  • Loading branch information
hidmic authored May 30, 2024
1 parent 825c0ed commit 70e7fe5
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 4 deletions.
Binary file added docs/_images/jazzy_jalisco_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_images/rolling_ridley_logo.png
Binary file not shown.
22 changes: 20 additions & 2 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
# Installation

## Install binaries
## Installing binaries

Coming soon!
Beluga binaries are released to several [ROS distributions](../index.md#support), and thus are made available through package managers.

:::{important}
Only `beluga`, `beluga_ros`, and `beluga_amcl` packages are available as binaries. The rest must be [built from source](#building-from-source-with-ros).
:::

::::{tab-set}

:::{tab-item} Ubuntu
Follow the [official ROS documentation](https://docs.ros.org) on how to setup `apt` sources for the distribution of choice. You may also want to consider using `ros2-testing` repositories to get the absolute latest release for the target distribution.

Then:

```bash
sudo apt install ros-${ROS_DISTRO}-beluga*
```
:::

::::

## Building from source (with ROS)

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@ Beluga is supported on a number of ROS 1 and ROS 2 distributions, primarily on L
:text-align: center
![ROS 2 Iron Irwini logo](./_images/iron_irwini_logo.jpg)
:::
:::{grid-item-card} ROS 2 Rolling Ridley
:::{grid-item-card} ROS 2 Jazzy Jalisco
:text-align: center
![ROS 2 Rolling Ridley logo](./_images/rolling_ridley_logo.png)
![ROS 2 Jazzy Jalisco logo](./_images/jazzy_jalisco_logo.png)
:::
::::

Expand Down

0 comments on commit 70e7fe5

Please sign in to comment.