Skip to content

Commit

Permalink
minor improvements to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Marco Boneberger committed Oct 20, 2023
1 parent 52f83c6 commit d66cf66
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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],
Expand Down

0 comments on commit d66cf66

Please sign in to comment.