diff --git a/README.md b/README.md index 515fda5..f1e45c8 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ Build cargo projects with colcon. ## Usage -Packages need to have a `package.xml` in addition to `Cargo.toml`. You should see such packages classified as `ament_cargo` in the output of `colcon list`. If they are classified as `ros.ament_cargo` instead, the `colcon-ros-cargo` extension has not been found by `colcon`. Make sure that you have built and loaded (`source install/setup.bash`) the extension. +Packages need to have a `package.xml` in addition to `Cargo.toml`. Make sure that you have built and loaded (`source install/setup.bash`) the extension. -Simply list dependencies (other `ament_cargo` packages or message packages) in `Cargo.toml` and `package.xml` as if they were hosted on crates.io. `colcon-ros-cargo` will find the dependencies and create a `.cargo/config.toml` file that helps cargo find these packages. +Simply list dependencies (other `ros.ament_cargo` packages or message packages) in `Cargo.toml` and `package.xml` as if they were hosted on crates.io. `colcon-ros-cargo` will find the dependencies and create a `.cargo/config.toml` file that helps cargo find these packages. Extra arguments to `cargo` can be passed via the `--cargo-args` option, e.g. `colcon build --cargo-args --release`. @@ -18,5 +18,3 @@ After building, run binaries with `ros2 run`. This is by far not a perfect build system. Notably, there is _quadratic_ build cost as a function of the dependency chain length. To illustrate this, assume there are packages A, B and C, where C depends on B and B depends on A. If colcon builds this workspace, it builds A first, then B, then C. However, Cargo will _also_ build all the dependencies, i.e., to build B, Cargo will build A again, and to build C, it will build A and B again. - -`colcon test` is not yet supported. \ No newline at end of file