Skip to content

Commit be4a682

Browse files
committed
doc: add note that the debian packages provied only support ubuntu 20 for now
1 parent b909130 commit be4a682

File tree

2 files changed

+20
-12
lines changed

2 files changed

+20
-12
lines changed

README.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ Before using **libfranka**, ensure your system meets the following requirements:
4545
3. Install from Debian Package - Generic Pattern
4646
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4747

48+
.. note::
49+
50+
The installation packages currently only support Ubuntu 20 (focal). Please ensure you are using this version to avoid compatibility issues.
51+
4852
**Check your architecture:**
4953

5054
.. code-block:: bash
@@ -55,17 +59,17 @@ Before using **libfranka**, ensure your system meets the following requirements:
5559

5660
.. code-block:: bash
5761
58-
wget https://github.com/frankarobotics/libfranka/releases/download/<version>/libfranka_<version>_<architecture>.deb
59-
sudo dpkg -i libfranka_<version>_<architecture>.deb
62+
wget https://github.com/frankarobotics/libfranka/releases/download/<version>/libfranka_<version>_<Ubuntu_version>_<architecture>.deb
63+
sudo dpkg -i libfranka_<version>_<Ubuntu_version>_<architecture>.deb
6064
61-
Replace ``<version>`` with the desired release version (e.g., ``0.18.1``) and ``<architecture>`` with your system architecture (e.g., ``amd64`` or ``arm64``).
65+
Replace ``<version>`` with the desired release version (e.g., ``0.18.2``, <Ubuntu_version> with ``focal`` and ``<architecture>`` with your system architecture (e.g., ``amd64`` or ``arm64``).
6266

63-
**Example for version 0.18.1 on amd64:**
67+
**Example for version 0.18.2 on amd64:**
6468

6569
.. code-block:: bash
6670
67-
wget https://github.com/frankarobotics/libfranka/releases/download/0.18.1/libfranka_0.18.1_amd64.deb
68-
sudo dpkg -i libfranka_0.18.1_amd64.deb
71+
wget https://github.com/frankarobotics/libfranka/releases/download/0.18.2/libfranka_0.18.2_focal_amd64.deb
72+
sudo dpkg -i libfranka_0.18.2_focal_amd64.deb
6973
7074
.. _building-in-docker:
7175
4. Building libfranka Inside Docker
@@ -235,7 +239,7 @@ Expected output:
235239

236240
.. code-block:: text
237241
238-
ii libfranka 0.18.1-9-g722bf63 amd64 libfranka built using CMake
242+
ii libfranka 0.18.2-9-g722bf63 amd64 libfranka built using CMake
239243
240244
241245
.. _building-from-source:

docs/installation.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,35 @@
33
Build / Installation
44
--------------------
55

6+
.. note::
7+
8+
The installation packages currently only support Ubuntu 20.04. Please ensure you are using this version to avoid compatibility issues.
9+
610
.. _libfranka_installation_debian_package:
711
Debian Package
812
~~~~~~~~~~~~~~
913

10-
Starting with version 0.18.1, **libfranka** releases are provided as pre-built Debian packages.
14+
**libfranka** releases are provided as pre-built Debian packages.
1115
You can find the packaged artifacts on the `libfranka releases <https://github.com/frankarobotics/libfranka/releases/>`_ page on GitHub.
1216

1317
Download the Debian package:
1418

1519
.. code-block:: bash
1620
17-
wget https://github.com/frankarobotics/libfranka/releases/download/0.18.1/libfranka_0.18.1_amd64.deb
21+
wget https://github.com/frankarobotics/libfranka/releases/download/0.18.2/libfranka_0.18.2_focal_amd64.deb
1822
1923
Install the package on your system:
2024

2125
.. code-block:: bash
2226
23-
sudo dpkg -i libfranka_0.18.1_amd64.deb
27+
sudo dpkg -i libfranka_0.18.2_focal_amd64.deb
2428
2529
For other versions or architectures, use the following pattern:
2630

2731
.. code-block:: bash
2832
29-
wget https://github.com/frankarobotics/libfranka/releases/download/<version>/libfranka_<version>_<architecture>.deb
30-
sudo dpkg -i libfranka_<version>_<architecture>.deb
33+
wget https://github.com/frankarobotics/libfranka/releases/download/<version>/libfranka_<version>_<Ubuntu_version>_<architecture>.deb
34+
sudo dpkg -i libfranka_<version>_<Ubuntu_version>_<architecture>.deb
3135
3236
This is the recommended installation method for **libfranka** if you do not need to modify the source code.
3337

0 commit comments

Comments
 (0)