README.md 1.32 KB
Newer Older
François Grisez's avatar
François Grisez committed
1 2 3
What's Belr
===========

4
Belr is Belledonne Communications' language recognition library.
François Grisez's avatar
François Grisez committed
5 6
It aims at parsing any input formatted according to a language defined by an ABNF grammar,
such as the protocols standardized at IETF.
7 8 9 10

It is based on finite state machine theory and heavily relies on recursivity from an implementation standpoint.


François Grisez's avatar
François Grisez committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
Dependencies
============

- *bctoolbox[1]*: our portability layer


Build Belr
==========

		cmake . -DCMAKE_INSTALL_PREFIX=<prefix> -DCMAKE_PREFIX_PATH=<search_prefixes>
		
		make
		make install


Build options
=============

* `CMAKE_INSTALL_PREFIX=<string>`: install prefix
* `CMAKE_PREFIX_PATH=<string>`: column-separated list of prefixes where to search for dependencies
* `ENABLE_SHARED=NO`: do not build the shared library
* `ENABLE_STATIC=NO`: do not build the static library
* `ENABLE_STRICT=NO`: build without strict compilation flags (-Wall -Werror)
* `ENABLE_TOOLS=NO`: do not build tools (belr-demo, belr-parse)


Note for packagers
==================

Our CMake scripts may automatically add some paths into research paths of generated binaries.
To ensure that the installed binaries are striped of any rpath, use `-DCMAKE_SKIP_INSTALL_RPATH=ON`
while you invoke cmake.

44

François Grisez's avatar
François Grisez committed
45
-----------------------
46

François Grisez's avatar
François Grisez committed
47
* [1] git://git.linphon.org/bctoolbox.git or <http://www.linphone.org/releases/sources/bctoolbox>