Skip to content

Commit 0b3fa66

Browse files
committed
docs: fix README broken links
1 parent 56f3411 commit 0b3fa66

File tree

1 file changed

+34
-18
lines changed

1 file changed

+34
-18
lines changed

README.rst

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ libfranka: C++ Library for Franka Robotics Research Robots
55
:target: https://codecov.io/gh/frankarobotics/libfranka
66
:alt: codecov
77

8-
**libfranka** is a C++ library that provides low-level control of Franka Robotics research robots. The `API References <https://frankarobotics.github.io/docs/libfranka/docs/api_references.html>`_ offers an overview of its capabilities, while the `Franka Control Interface (FCI) documentation <https://frankarobotics.github.io/docs>`_ provides more information on setting up the robot and utilizing its features and functionalities.
8+
**libfranka** is a C++ library that provides low-level control of Franka Robotics research robots.
9+
The `API References <https://frankarobotics.github.io/docs/libfranka/docs/api_references.html>`_ offers an overview of its capabilities,
10+
while the `Franka Control Interface (FCI) documentation <https://frankarobotics.github.io/docs>`_ provides more information on setting up the robot and utilizing its features and functionalities.
911

1012
To find the appropriate version to use, please refer to the `Robot System Version Compatibility <https://frankarobotics.github.io/docs/libfranka/docs/compatibility_with_images.html>`_.
1113

@@ -40,26 +42,33 @@ Before using **libfranka**, ensure your system meets the following requirements:
4042
sudo apt-get update
4143
sudo apt-get install -y build-essential cmake git libpoco-dev libeigen3-dev libfmt-dev
4244
43-
To use libfranka version ``0.14.0`` or later, you will need to install `pinocchio <https://stack-of-tasks.github.io/pinocchio/download.html>`_ and some more dependencies:
45+
3. Install from Debian Package - Generic Pattern
46+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
47+
48+
**Check your architecture:**
4449

4550
.. code-block:: bash
4651
47-
sudo apt-get install -y lsb-release curl
48-
sudo mkdir -p /etc/apt/keyrings
49-
curl -fsSL http://robotpkg.openrobots.org/packages/debian/robotpkg.asc | sudo tee /etc/apt/keyrings/robotpkg.asc
52+
dpkg --print-architecture
53+
54+
**Download and install:**
5055

5156
.. code-block:: bash
5257
53-
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/robotpkg.asc] http://robotpkg.openrobots.org/packages/debian/pub $(lsb_release -cs) robotpkg" | sudo tee /etc/apt/sources.list.d/robotpkg.list
58+
wget https://github.com/frankarobotics/libfranka/releases/download/<version>/libfranka_<version>_<architecture>.deb
59+
sudo dpkg -i libfranka_<version>_<architecture>.deb
60+
61+
Replace ``<version>`` with the desired release version (e.g., ``0.18.1``) and ``<architecture>`` with your system architecture (e.g., ``amd64`` or ``arm64``).
62+
63+
**Example for version 0.18.1 on amd64:**
5464

5565
.. code-block:: bash
5666
57-
sudo apt-get update
58-
sudo apt-get install -y robotpkg-pinocchio
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
5969
6070
.. _building-in-docker:
61-
62-
3. Building libfranka Inside Docker
71+
4. Building libfranka Inside Docker
6372
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6473

6574
If you prefer to build **libfranka** inside a Docker container, you can use the provided Docker setup. This ensures a consistent build environment and avoids dependency conflicts on your host system.
@@ -231,7 +240,7 @@ Expected output:
231240
232241
.. _building-from-source:
233242

234-
4. Building and Installation from Source
243+
5. Building and Installation from Source
235244
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
236245

237246
Before building and installing from source, please uninstall existing installations of libfranka to avoid conflicts:
@@ -299,14 +308,18 @@ This command creates a Debian package named libfranka-<version>-<architecture>.d
299308
300309
sudo dpkg -i libfranka*.deb
301310
302-
Installing via a Debian package simplifies the process compared to building from source every time. Additionally the package integrates better with system tools and package managers, which can help manage updates and dependencies more effectively.
311+
Installing via a Debian package simplifies the process compared to building from source every time. Additionally the package integrates better with
312+
system tools and package managers, which can help manage updates and dependencies more effectively.
303313

304314
.. _usage:
305315

306-
5. Usage
316+
6. Usage
307317
~~~~~~~~
308318

309-
After installation, check the `Minimum System and Network Requirements <https://frankarobotics.github.io/docs/requirements.html>`_ for network settings, the `Operating System and PC Configuration <https://frankarobotics.github.io/docs/installation_linux.html#setting-up-the-real-time-kernel>`_ for system setup, and the `Getting Started Manual <https://frankarobotics.github.io/docs/getting_started.html#>`_ for initial steps. Once configured, you can control the robot using the example applications provided in the examples folder.
319+
After installation, check the `Minimum System and Network Requirements <https://frankarobotics.github.io/docs/libfranka/docs/system_requirements.html>`_ for network settings,
320+
the `Setting up the Real-Time Kernel <https://frankarobotics.github.io/docs/libfranka/docs/real_time_kernel.html>`_ for system setup,
321+
and the `Getting Started Manual <https://frankarobotics.github.io/docs/libfranka/docs/getting_started.html>`_ for initial steps. Once configured,
322+
you can control the robot using the example applications provided in the examples folder (`Usage Examples <https://frankarobotics.github.io/docs/libfranka/docs/usage_examples.html>`_).
310323

311324
To run a sample program, navigate to the build folder and execute the following command:
312325

@@ -316,14 +329,16 @@ To run a sample program, navigate to the build folder and execute the following
316329
317330
.. _pylibfranka:
318331

319-
6. Pylibfranka
332+
7. Pylibfranka
320333
~~~~~~~~~~~~~~
321334

322-
Pylibfranka is a Python binding for libfranka, allowing you to control Franka robots using Python. It is included in the libfranka repository and can be built alongside libfranka. For more details, see ``pylibfranka`` and its `README <pylibfranka/README.md>`_. The `generated API documentation <https://frankarobotics.github.io/libfranka/pylibfranka/latest>`_ offers an overview of its capabilities.
335+
Pylibfranka is a Python binding for libfranka, allowing you to control Franka robots using Python. It is included in the libfranka repository and
336+
can be built alongside libfranka. For more details, see ``pylibfranka`` and its `README <pylibfranka/README.md>`_.
337+
The `generated API documentation <https://frankarobotics.github.io/libfranka/pylibfranka/latest>`_ offers an overview of its capabilities.
323338

324339
.. _development-information:
325340

326-
7. Development Information
341+
8. Development Information
327342
~~~~~~~~~~~~~~~~~~~~~~~~~~
328343

329344
If you actively contribute to this repository, you should install and set up pre-commit hooks:
@@ -333,7 +348,8 @@ If you actively contribute to this repository, you should install and set up pre
333348
pip install pre-commit
334349
pre-commit install
335350
336-
This will install pre-commit and set up the git hooks to automatically run checks before each commit. The hooks will help maintain code quality by running various checks like code formatting, linting, and other validations.
351+
This will install pre-commit and set up the git hooks to automatically run checks before each commit.
352+
The hooks will help maintain code quality by running various checks like code formatting, linting, and other validations.
337353

338354
To manually run the pre-commit checks on all files:
339355

0 commit comments

Comments
 (0)