btllib
|
BTL common code library in C++ with Python and Java wrappers.
Open docs/index.html
with a browser and look up any classes/functions you need.
btllib/include
directorybtllib/compile
sys.path.append()
to include btllib/python
directoryimport btllib
btllib/java
to classpathimport btllib.*
If you want to contribute code to this repo, before making a pull request, make sure to:
meson build
in btllib
directoryninja complete
in the build
directory to generate wrappers, docs, format the code, check for any errors, etc.ninja complete
does the following steps, in order:
ninja format
formats the whitespace in code (requires clang-format 8+)ninja wrap
wraps C++ code for Python and Java (requires SWIG 4.0+)ninja
builds the tests and wrapper libraries / makes sure they compileninja test
runs the testsninja tidycheck
runs clang-tidy on C++ code and makes sure it passes (requires clang-tidy 8+)ninja cppcheck
runs cppcheck on C++ code and makes sure it passes (requires cppcheck)ninja docs
generates code documentation from comments (requires Doxygen)Any of these can be run individually within build
directory.