diff --git a/README.md b/README.md index 11b209a8..bbbeae71 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Peng is a minimal quadrotor autonomy framework in Rust. It includes a simulator, ### Installation from Crates.io ```bash -cargo install rerun-cli # ensure you installed rerun-cli>=0.18.2 by checking rerun --version +cargo install rerun-cli # ensure you installed rerun-cli>=0.19.0 by checking rerun --version cargo install peng_quad peng_quad config/quad.yaml ``` diff --git a/src/config.rs b/src/config.rs index 6661cc95..b08a7f49 100644 --- a/src/config.rs +++ b/src/config.rs @@ -1,4 +1,5 @@ //! Configuration module +//! //! This module contains the configuration for the simulation, quadrotor, PID controller, IMU, maze, camera, mesh, and planner schedule. //! The configuration is loaded from a YAML file using the serde library. //! The configuration is then used to initialize the simulation, quadrotor, PID controller, IMU, maze, camera, mesh, and planner schedule. diff --git a/src/lib.rs b/src/lib.rs index febf717e..e5ada6b8 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1278,6 +1278,7 @@ impl PlannerManager { } } /// Obstacle avoidance planner that uses a potential field approach to avoid obstacles +/// /// The planner calculates a repulsive force for each obstacle and an attractive force towards the goal /// The resulting force is then used to calculate the desired position and velocity /// # Example