Commit 2fc46087 authored by François Grisez's avatar François Grisez

Update README.md

parent 9ddd151a
What's Belr
===========
Belr is Belledonne Communications' language recognition library. Belr is Belledonne Communications' language recognition library.
It aims at parsing any input formatted according to a language defined by an ABNF grammar, such as the protocols standardized at IETF. It aims at parsing any input formatted according to a language defined by an ABNF grammar,
such as the protocols standardized at IETF.
It is based on finite state machine theory and heavily relies on recursivity from an implementation standpoint. It is based on finite state machine theory and heavily relies on recursivity from an implementation standpoint.
<TODO: provide an example of usage here> 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.
-----------------------
* [1] git://git.linphon.org/bctoolbox.git or <http://www.linphone.org/releases/sources/bctoolbox>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment