From 05b205613e65067379274775b5222c2faa1f6a20 Mon Sep 17 00:00:00 2001 From: Bartosz Golaszewski Date: Sat, 21 Apr 2018 15:29:33 +0200 Subject: [PATCH] README: add info about high-level bindings Briefly describe C++ and python bindings. Signed-off-by: Bartosz Golaszewski --- README | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README b/README index be150f2..6309a49 100644 --- a/README +++ b/README @@ -130,6 +130,25 @@ superuser privileges: sudo ./tests/gpiod-test +BINDINGS +-------- + +High-level, object-oriented bindings for C++ and python3 are provided. They +can be enabled by passing --enable-bindings-cxx and --enable-bindings-python +arguments respectively to configure. + +C++ bindings require C++11 support and autoconf-archive collection if building +from git. + +Python bindings require python3 support and libpython development files. Care +must be taken when cross-compiling python bindings: users usually must specify +the PYTHON_CPPFLAGS and PYTHON_LIBS variables in order to point the build +system to the correct locations. During native builds, the configure script +can auto-detect the location of the development files. + +Both bindings are extensively documented: with doxygen markup in case of C++ +and inline pydoc comments for python. + CONTRIBUTING ------------ -- 2.30.2