backscrub icon indicating copy to clipboard operation
backscrub copied to clipboard

Readme.md: build and usage guide inconsistent

Open thomas725 opened this issue 4 years ago • 3 comments

Your build guide tells to build in a separate subfolder "build", but the usage guide assumes that the built backscrub binary is in the same folder as the models directory

To make the usage guide compatible with the build guide, you either have to add the path to the model:

./backscrub -d -d -c /dev/video0 -v /dev/video10 -m ../models/selfiesegmentation_mlkit-256x256-2021_01_19-v1215.f16.tflite -b ../images/background_bauhaus.png

or you start it from outside the build directory:

build/backscrub -d -d -c /dev/video0 -v /dev/video10 -b images/background_bauhaus.png

thomas725 avatar Nov 06 '21 07:11 thomas725

It's more complicated than that, actually. ;-) There is some magic on IIRC experimental (soon to lang on main) that goes without the paths completely and looks for those directories itself. So you would need relative paths only if things were outside the default directories of the tool.

BenBE avatar Nov 06 '21 10:11 BenBE

It's probably a hangover from the Makefile build that dropped the binary in $cwd and which I think we ought to retire as it's not feature compatible with the CMake build (no XNNPACK support).

That said - it always helps to have working cut'n paste docs :smile:

phlash avatar Nov 07 '21 18:11 phlash

Related to #127, when the README.md gets updated there we should fix this (if required)

phlash avatar Dec 16 '21 10:12 phlash