Skip to content

Fix opencv example readme section#400

Merged
christian-rauch merged 2 commits into
AprilRobotics:masterfrom
reprojection-calibration:readme-fix
Sep 26, 2025
Merged

Fix opencv example readme section#400
christian-rauch merged 2 commits into
AprilRobotics:masterfrom
reprojection-calibration:readme-fix

Conversation

@reprojection-calibration

Copy link
Copy Markdown
Contributor

The opencv example readme section directs users to run the following commands:

$ cd examples
$ make opencv_demo

The first command does not work because the folder is called "example/" not "examples/" and the second command fails with unknown include errors because there is no build configuration or file or Makefile to actually orchestrate building the opencv demo.

Given that the examples are built by default I propose that the readme is changed to simply instruct people to build and then run ./build/opencv_demo. This works like charm and is easy to understand.

@christian-rauch

Copy link
Copy Markdown
Collaborator

Yes, the command make opencv_demo only works for the default make file generator and not with -GNinja. I would probably skip this specific build instruction altogether. The opencv_demo target is built by default if OpenCV is available. We only need to document how to install the OpenCV dependency and how to start the example executable.

@christian-rauch christian-rauch merged commit d7aa51c into AprilRobotics:master Sep 26, 2025
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants