Update README to markdown syntax and add MacOS homebrew instructions

parent 9bde7fd7
Overview
********
Belle-sip is a SIP (RFC3261) implementation written in C, with an object oriented API.
Please check "NEWS" file for an overview of current features.
Copyright 2012-2014, Belledonne Communications SARL <contact@belledonne-communications.com>, all rights reserved.
Belle-sip is distributed to everyone under the GNU GPLv2 (see COPYING file for details).
Incorporating belle-sip within a closed source project is not possible under the GPL.
Commercial licensing can be purchased for that purpose from Belledonne Communications (http://www.belledonne-communications.com).
Dependencies
************
*libtool
*intltool
*pkg-config
*libantlr3c-3.2 or 3.4
*antlr3-3.2 or 3.4
*C++ compiler (for instance g++ or clang++)
Newer versions won't compile.
Optional:
*CUinit-2.x
*polarssl>=1.2
Here is the command line to get these dependencies installed for Ubuntu && Debian:
# apt-get install libtool intltool pkg-config libantlr3c-dev antlr3 g++ make
+ for optional library
# apt-get install libcunit1-dev libpolarssl-dev
On windows you have to edit /usr/local/include/antl3defs.h
replace:
#include <winsock.h>
by:
#include <winsock2.h>
Or get the source code from linphone's git (linphone branch):
git clone -b linphone git://git.linphone.org/antlr3.git
git clone -b linphone git://git.linphone.org/cunit.git
* Building polarssl
Polarssl build system is Make (or Cmake). To build the shared library version, use "make SHARED=1 DEBUG=1", followed by "make install".
We maintain a branch of polarssl with automake/autoconf/libtool support at git://git.linphone.org/polarssl.git -b linphone
Prequisites
***********
You must jave 'java' in your PATH.
Build with mingw
****************
* Compile and install libantlr3c, CUnit with ./configure && make && make install
* Compile belle-sip.
Build with Visual Studio
************************
The procedure is tested for Visual Studio Express 2012.
* get antlr3 from linphone's git server (see above). This version contains up to date visual studio project and solution files.
* get CUnit from linphone's git server (see above). This version contains up to date visual studio project and solution files.
* put belle-sip next to antlr3 and to cunit (in the same directory).
* open belle-sip/build/windows/belle-sip-tester/belle-sip-tester.sln or belle-sip/build/windows/belle-sip/belle-sip.sln
* Build the solution (antlr3 and cunit are built automatically)
# Belle-sip
## Overview
Belle-sip is a SIP (RFC3261) implementation written in C, with an object oriented API.
Please check "NEWS" file for an overview of current features.
Copyright 2012-2014, Belledonne Communications SARL <contact@belledonne-communications.com>, all rights reserved.
Belle-sip is distributed to everyone under the GNU GPLv2 (see COPYING file for details).
Incorporating belle-sip within a closed source project is not possible under the GPL.
Commercial licensing can be purchased for that purpose from [Belledonne Communications](http://www.belledonne-communications.com).
## Build prerequisite
* [Java SE](http://www.oracle.com/technetwork/java/javase/downloads/index.html) on openJDK
This is required to generate a C sourcefile from SIP grammar using [antlr3](http://www.antlr3.org/) generator.
### Dependencies
* libtool
* intltool
* pkg-config
* libantlr3c-3.2 or 3.4
* antlr3-3.2 or 3.4
* C++ compiler (for instance g++ or clang++)
* (optional) CUnit
* (optional) polarssl >= 1.2 (see below)
#### Under Debian/Ubuntu
apt-get install libtool intltool pkg-config libantlr3c-dev antlr3 g++ make
#and for optional dependencies
apt-get install libcunit1-dev libpolarssl-dev
#### Under MacOS X using HomeBrew
brew tap Gui13/linphone
brew install intltool libtool pkg-config automake libantlr3.4c antlr3.2
ln -s /usr/local/bin/glibtoolize /usr/local/bin/libtoolize
#### Under Windows using mingw and Visual Studio
The procedure is tested for Visual Studio Express 2012.
* Compile and install libantlr3c, CUnit with ./configure && make && make install
* get antlr3 from linphone's git server (see above). This version contains up to date visual studio project and solution files.
* get CUnit from linphone's git server (see above). This version contains up to date visual studio project and solution files.
* put belle-sip next to antlr3 and to cunit (in the same directory).
* open belle-sip/build/windows/belle-sip-tester/belle-sip-tester.sln or belle-sip/build/windows/belle-sip/belle-sip.sln
* Build the solution (antlr3 and cunit are built automatically)
#### Building polarssl
Polarssl build system is Make (or Cmake).
To build the shared library version, use `make SHARED=1 DEBUG=1`, followed by `make install`.
We maintain a branch of polarssl with automake/autoconf/libtool support at
git://git.linphone.org/polarssl.git -b linphone
#### Known issues
1. Antlr3 on windows
On windows you have to edit /usr/local/include/antl3defs.h replace:
#include <winsock.h>
with:
#include <winsock2.h>
Or get the source code from linphone's git (linphone branch):
git clone -b linphone git://git.linphone.org/antlr3.git
git clone -b linphone git://git.linphone.org/cunit.git
......@@ -30,7 +30,7 @@ Libraries and headers required to develop software with belle-sip
%build
%configure \
--disable-tests --enable-static --docdir=%{_docdir}
--disable-tests --enable-static --docdir=%{_docdir}
%__make %{?_smp_mflags}
......@@ -46,9 +46,9 @@ rm -rf $RPM_BUILD_ROOT
%postun -p /sbin/ldconfig
%files
%files
%defattr(-,root,root)
%doc AUTHORS ChangeLog COPYING NEWS README
%doc AUTHORS ChangeLog COPYING NEWS README.md
%{_libdir}/*.so.*
%files devel
......
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