Skip to content

Commit

Permalink
README: add paragraph about bindings generation
Browse files Browse the repository at this point in the history
  • Loading branch information
Gnurou committed Sep 5, 2024
1 parent 27ba504 commit 6a7d98d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ e.g. video decoding and encoding.
library other projects can link against. A `v4l2r.h` header file with the public
API is generated upon build.

## Build options

`cargo build` will attempt to generate the V4L2 bindings from
`/usr/include/linux/videodev2.h` by default. The `V4L2R_VIDEODEV2_H_PATH`
environment variable can be set to a different location that contains a
`videodev2.h` file if you need to generate the bindings from a different
location.

## How to use

Check `lib/examples/vicodec_test/device_api.rs` for a short example of how to
Expand Down

0 comments on commit 6a7d98d

Please sign in to comment.