********************* Build instructions******************************************
	On linux, you need at least libspeex>1.1.6 and libosip2>=2.2.0
	For other unices, glib-2.x is highly recommended additionnaly.
	You need to configure linphone usually as this:
		./configure --prefix=/usr
	Then compile with
		make
	And install the software with:
		make install
		
	If you want the gnome interface, then be sure to have libgnomeui-dev package installed.
	If you don't want the gnome interface, use configure --disable-glib --disable-gnome_ui

Then run linphone, from the gnome menu, or by invoking the command "linphone".
If you want to use the console version, invoke "linphonec".

************************About plugins******************************************
Since version 1.2.0 it is possible to add plugins to linphone for audio processing: 
new codecs or new sound interfaces. 



************************************** user documentation *********************
go to linphone's web site: http://www.linphone.org


******************************** DEVELOPER documentation ********************

Here is a short description of the content of the source tree.

- oRTP/ is a poweful implementation of the RTP protocol. See the oRTP/README for more details. 
	It is used by the mediastreamer to send and receive streams to the network.
	
- exosip/ is user-agent library based on the osip SIP stack (http://osip.atosc.org). 
	
- ffmpeg/ is the ffmpeg library (http://ffmpeg.sourceforge.net). It contains mostly video codecs
	wrapped by the mediastreamer library. 

- gsmlib/ and lpc10-1.5/ are libraries that implement the GSM and LPC-10 vocoders (or codec). These are compression algorithm designed for voice. They can
	compress voice very efficiently. These libraries are not the complete ones I've pick up the core code only. See AUTHORS files in these directory
	for more information. They are used by the mediastreamer.
	

- mediastreamer/ is one of the biggest part of linphone. It is a framework library for audio 
	and video processing. It contains several objects for grabing audio and video and outputing
	it (through rtp, to file).
	It contains also codec objects to compress audio and video streams.
  The mediastream.h files contain routines to easyly setup audio streams.
	
- media_api/ is going to be an easy to use library to handle audio and video session. It uses 
	the mediastreamer at the backend to do the processing. It is going to be the only interface
	between the core application and the mediastreamer. At the moment this library is still in
	early stages of development and is unused by the core application.

- coreapi/ is the central point of linphone, which handles relationship between sip signalisation and media
  streaming. It contains an easy to use api to create a sip phone.

- gnome/	is the directory that contains the core files (gui) of linphone. It uses all libraries descibed above.
	* interface.c is the file generated by glade to construct the graphical interface.
	* callbacks.c contains the Gtk+ callbacks and callbacks of the sip library (we are called in these functions when we are invited, for example)
	* support.c is auto-generated by Glade.
  * propertybox.c : the code to handle the property box
  * presence.c : the code to handle the presence box
  * addressbook.c : the code to handle the address book
	* linphone.c : the main code of gnome interface
  * applet.c : the gnome applet.
	* main.c : contains the main() function of linphone's gnome interface, and the gtk_main() call.
	
- console/
	* linphonec.c is the main file for the console version of linphone.
	* sipomatic.c / sipomatic.h contains the code for sipomatic, the test program that auto-answer to linphone calls. If you want to understand
		how linphone runs, this is a good start example.
		
- share/ contains translation, documentation, rings and hello sound files.

- developer-docs/ contains html documentation of the mediastreamer and osipua libraries.

Contact me (simon dot morlat at linphone dot org) if you want more information, or if you want to help the linphone project.

Simon MORLAT
