Commit 6e3ec403 authored by François Grisez's avatar François Grisez

Migrate README.md into Markdown syntax

parent 1ccbe206
BelCard
=======
Belcard is a C++ library to manipulate VCard standard format
Dependencies
------------
* bctoolbox (git://git.linhpone.org/bctoolbox.git)
* belr (git://git.linphone.org/belr.git)
- *bctoolbox[1]* : portability layer.
- *belr[2]* : used to parse VCard format.
Build instrucitons
------------------
cmake . -DCMAKE_INSTALL_PREFIX=<install_prefix> -DCMAKE_PREFIX_PATH=<search_prefix>
make
make install
cmake . -DCMAKE_INSTALL_PREFIX=<install_prefix> -DCMAKE_PREFIX_PATH=<search_prefix>
make
make install
Options
-------
CMAKE_INSTALL_PREFIX=<string>: installation prefix
CMAKE_PREFIX_PATH=<string>: prefix where depedencies are installed
ENABLE_UNIT_TESTS=<bool>: compile non-regression tests
- `CMAKE_INSTALL_PREFIX=<string>` : installation prefix
- `CMAKE_PREFIX_PATH=<string>` : prefix where depedencies are installed
- `ENABLE_UNIT_TESTS=NO` : do not compile non-regression tests
- `ENABLE_SHARED=NO` : do not build the shared library.
- `ENABLE_STATIC=NO` : do not build the static library.
- `ENABLE_STRICT=NO` : do not build with strict complier flags e.g. `-Wall -Werror`
Note for packagers
------------------
Our CMake scripts may automatically add some path into research paths of generated binaries.
To ensure that the installed binaries are striped of any rpath, use -DCMAKE_SKIP_INSTALL_RPATH=ON
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.linphone.org/bctoolbox.git or <http://www.linphone.org/releases/sources/bctoolbox>
- [2] git://git.linphone.org/belr.git or <http://www.linphone.org/releases/sources/belr>
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