search

Kitware / fletch

Computer Vision Software Development Environment
63 stars 54 forks source link

Clarify what "Building Fletch" means #750

Closed dabrahams closed 4 months ago

dabrahams commented 7 months ago

Building Fletch is a section in the README, but since it also says Fletch is “a pure CMake project” it's unclear what it might mean to build fletch, and the README is confusing. I can, if I stretch my brain a bit, imagine that Fletch contains some generated CMake files, perhaps? What Fletch actually is would be a lot clearer if you'd spell that info out. Thanks

aronhelser commented 7 months ago

I think the "Motivation" section spells this out pretty clearly. Maybe there is a better organization that would be clearer?

dabrahams commented 7 months ago

No, it doesn't explain what "building fletch" means, unless in this context "building fletch" means building what "fletch builds" (according to the same section): OpenCV, VXL, VTK, etc… a somewhat circular semantics.

I got the impression from the Motivation section that Fletch is a generalized package manager that just happens to be used, in its default configuration, for a very specific purpose, but maybe the truth is that it is just a project to encode the build instructions for a bunch of Kwiver dependencies?

Erotemic commented 7 months ago

Would it help to add a blurb like:

Building Fletch results in a set of inter-compatable shared libraries suitable for use in downstream applications - with the primary consumer being KWIVER. Using the CMake configuration, the user specifies which libraries to build, and Fletch handles ensuring the chosen set is compatible.

dabrahams commented 7 months ago

Yes that would clear it up