From 8d7f3a60f7784e0461f2fb25dc6b2ae756d07d5e Mon Sep 17 00:00:00 2001 From: matteo brancaleoni Date: Mon, 22 Jul 2013 15:04:31 +0200 Subject: [PATCH] add a couple of instructions --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 77d5449..76426a1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,30 @@ mod_bcg729 ========== -FreeSWITCH G.729 module using the opensource bcg729 implementation by Belledonne Communications +FreeSWITCH G.729 module using the opensource bcg729 implementation by Belledonne Communications. + +Simple G.729 codec for FreeSWITCH using the Belledone Communications G.729 GPLv2 implementation. +Please see http://www.linphone.org/eng/documentation/dev/bcg729.html for further informations. + +To use G.729 or G.723.1 you may need to pay a royalty fee. +Please see http://www.sipro.com for details. +Please note that this code is available for you to download for education purposes +only and if a patent exists in your country for G.729 then you should contact +the owner of that patent and request their permission before executing the code. + +You can get a licensed, faster and supported G.729 codec by purchasing licenses +directly from FreeSWITCH guys http://www.freeswitch.org/node/235 . +This will have the side effect to support the FreeSWICTH project ;) + +Installation +============ +You need to have git on your build machine and internet access, since +the Makefile will try to checkout bcg729 sources and build them. + +Edit Makefile and edit FS_INCLUDES, FS_MODULES vars to point where +your FreeSWICTH includes are and where you want to install the module. + +After, just type make and, if build completes without errors, make install . + +Edit autoload_configs/modules.conf.xml , comment out mod_g729 and add mod_bcg729 . +Now restart your FreeSWICTH and you're done.