[Pkg-voip-commits] [bctoolbox] 53/57: Update and migrate README into Markdown format

[daniel at gnoutcheff.name]

This is an automated email from the git hooks/post-receive script.

gnoutchd-guest pushed a commit to branch debian/sid
in repository bctoolbox.

commit d7ce4e5403f3d3ef940d83047b7ac7ef176fb272
Author: François Grisez <francois.grisez at belledonne-communications.com>
Date:   Thu Feb 23 16:38:45 2017 +0100

    Update and migrate README into Markdown format
---
 README    | 45 --------------------------------------------
 README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 64 insertions(+), 45 deletions(-)

diff --git a/README b/README
deleted file mode 100644
index 7899c53..0000000
--- a/README
+++ /dev/null
@@ -1,45 +0,0 @@
-Utilities library used by Belledonne Communications softwares like belle-sip, mediastreamer2 and linphone.
-
-Depends
--------
-* mbedtls (https://github.com/ARMmbed/mbedtls.git). For backward compatibility, support of polarssl is also provided.
-* bcunit (git://git.linphone.org/bcunit.git) for unitary test tools. (optional)
-
-To compile
-----------
-
-cmake . -DCMAKE_INSTALL_PREFIX=<install prefix> -DCMAKE_PREFIX_PATH=<search prefix>
-
-make
-make install
-
-To make an rpm package
----------------------
-cmake . -DCMAKE_INSTALL_PREFIX=/usr -DCPACK_GENERATOR="RPM"
-
-make package 
-
-Options
--------
-
-CMAKE_INSTALL_PREFIX: install prefix  
-ex:
-	cmake . -DCMAKE_INSTALL_PREFIX=/opt  
-
-CMAKE_PREFIX_PATH: search path prefix for dependencies e.g. mbedtls
-ex:
-	cmake . -DCMAKE_PREFIX_PATH=<polarssl or mbtls path>  
-
-ENABLE_POLARSSL: force usage of polarssl 
-ex:
-	cmake . -DENABLE_POLARSSL=ON -DENABLE_MBEDTLS=OFF  
-
-ENABLE_MBEDTLS: force usage of mbedtls
-ex:
-	cmake . -DENABLE_POLARSSL=OFF -DENABLE_MBEDTLS=ON  
-
-
-
-For backward compatibility with distributions not having the required 2.8.12 cmake version, an automake/autoconf build system is also available.
-It is maintained as a best effort and then should be used only in last resort.
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0b94ff5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,64 @@
+BcToolbox
+=========
+
+Utilities library used by Belledonne Communications softwares like belle-sip, mediastreamer2 and linphone.
+
+
+Depends
+-------
+
+- **mbedtls[1]**: implementation of TLS interface of BcToolbox. For backward
+  compatibility, support of polarssl is also provided.
+- **bcunit[2]** for unitary test tools. (optional)
+
+
+To compile
+----------
+
+	cmake . -DCMAKE_INSTALL_PREFIX=<install prefix> -DCMAKE_PREFIX_PATH=<search prefix>
+	
+	make
+	make install
+
+
+To make an rpm package
+----------------------
+
+	cmake . -DCMAKE_INSTALL_PREFIX=/usr -DCPACK_GENERATOR="RPM"
+	
+	make package 
+
+
+Options
+-------
+
+- `CMAKE_INSTALL_PREFIX=<string>`: install prefix.
+- `CMAKE_PREFIX_PATH=<string>`: search path prefix for dependencies e.g. mbedtls.
+- `ENABLE_MBEDTLS=NO`: do not look for mbedtls. Then, polarssl will be selected.
+- `ENABLE_POLARSSL=NO`: do not look for polarssl. That ensure to use mbedtls.
+- `ENABLE_SHARED=NO`: do not build the shared libraries.
+- `ENABLE_STATIC=NO`: do not build the static libraries.
+- `ENABLE_STRICT=NO`: do not build with strict compilator flags e.g. `-Wall -Werror`.
+- `ENABLE_TESTS=NO`: do not build testing binaries.
+- `ENABLE_TESTS_COMPONENT=NO`: do not build libbctoolbox-tester.
+
+
+Notes
+-----
+
+For backward compatibility with distributions not having the required 2.8.12 cmake version, an automake/autoconf build system is also available.
+It is maintained as a best effort and then should be used only in last resort.
+
+
+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] <https://github.com/ARMmbed/mbedtls.git>
+- [2] git://git.linphone.org/bctoolbox.git or <http://www.linphone.org/releases/sources/bctoolbox/>
+

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-voip/bctoolbox.git