docs: add missing cargo-ament-build to installation prerequisites#610
docs: add missing cargo-ament-build to installation prerequisites#610lncosinx wants to merge 1 commit intoros2-rust:mainfrom
Conversation
|
@lncosinx the |
Hi @esteve, thanks for the review and for pointing that out! Plaintext So pip did indeed install cargo-ament-build as a dependency. ament_cargo package found but cargo ament-build was not detected. Please install it by running: $ cargo install cargo-ament-build Since the error message generated by the build system explicitly suggests using cargo install cargo-ament-build, I followed that instruction (which put the binary in ~/.cargo/bin and fixed the build). That's why I proposed adding it to the documentation. Given that this was ultimately a $PATH issue on my end (missing ~/.local/bin) combined with a potentially misleading error message from the build script, how would you like to proceed?
I'm completely happy to close the PR or update it based on your preference! |
Description:
The current installation instructions missed the cargo-ament-build dependency. Without installing it globally via cargo install cargo-ament-build, running colcon build will fail with a fatal error stating "cargo ament-build was not detected".
Changes:
Added cargo install cargo-ament-build to the prerequisites block in README.md.
Added the same command to the "Option 1: Installing the dependencies" section in docs/building.md.
This will help new users successfully build the workspace without encountering the missing cargo plugin error.