From d66cf668cb7759d2fb1b311f7c303a434b4320f2 Mon Sep 17 00:00:00 2001 From: Marco Boneberger Date: Fri, 20 Oct 2023 15:04:02 +0200 Subject: [PATCH] minor improvements to documentation --- README.md | 7 ++++--- src/lib.rs | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fa7706a..4a7b959 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,8 @@ fn main() -> FrankaResult<()> { ## How to get started -As it is a straight port, you may find the + +Since libfranka-rs is a port of libfranka, you may find the [Franka Control Interface Documentation](https://frankaemika.github.io/docs/index.html) helpful. ### With zero Rust knowledge @@ -138,8 +139,8 @@ hoping that it makes your introduction into the Rust world as smooth as possible ### With zero libfranka knowledge The [Franka Control Interface Documentation](https://frankaemika.github.io/docs/index.html) also includes a setup guide. You can skip the installation of libfranka as you will be using libfranka-rs. -Take a look at the [Documentation](https://docs.rs/libfranka-rs) and the examples folder. You should run the -communication_test example to verify that your setup is correct. +Take a look at the [Documentation](https://docs.rs/libfranka-rs) and the [examples](examples) folder. You should run the +[communication_test](examples/communication_test.rs) example to verify that your setup is correct. ### How to use libfranka-rs If you want to use libfranka-rs in your project, you have to add diff --git a/src/lib.rs b/src/lib.rs index b575b0f..26e9af5 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -25,7 +25,7 @@ //! use std::f64::consts::PI; //! use franka::{JointPositions, MotionFinished, Robot, RobotState, Fr3, FrankaResult}; //! fn main() -> FrankaResult<()> { -//! let mut robot = Fr3::new("robotik-bs.de", None, None)?; +//! let mut robot = Fr3::new("robotik-bs.de", None, None)?; //! robot.set_default_behavior()?; //! robot.set_collision_behavior([20.0, 20.0, 18.0, 18.0, 16.0, 14.0, 12.0], [20.0, 20.0, 18.0, 18.0, 16.0, 14.0, 12.0], //! [20.0, 20.0, 18.0, 18.0, 16.0, 14.0, 12.0], [20.0, 20.0, 18.0, 18.0, 16.0, 14.0, 12.0],