purge out p2pproxy

[linphone] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..c92edbc
--- /dev/null
+++ b/README
@@ -0,0 +1,49 @@
+This is Linphone, a free (GPL) video softphone based on the SIP protocol.
+
+
+******************Building linphone ***********************************
+- you need at least:
+               - libosip2>=3.0.3
+               - libeXosip2>=3.0.3
+               - speex>=1.1.6
+               - libreadline
+       + gsm codec (gsm source package or libgsm-dev or gsm-devel) (optional)
+       + if you want to gtk/glade interface:
+               - gtk>=2.16.0
+               - libglade>=2.2
+       + if you want video support:
+               - SDL>=1.2.10
+               - libavcodec (ffmpeg) from a year 2007 or later cvs/svn
+               - libswscale (part of ffmpeg too) for better scaling performance
+
+with their corresponding -dev or -devel package if you don't use source packages.
+
+For windows compilation see README.mingw.
+For macOS X, see README.macos
+
+
+******************************** notes for developers: *****************************
+
+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.
+
+- mediastreamer2/ is one of the important 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.
+
+- 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.
+
+- gtk-glade/   is the directory that contains the gui frontend of linphone. It uses all libraries descibed above.
+
+- 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.
+       * shell.c (program name: linphonecsh) is a small utilities to send interactive commands to a running linphonec daemon.
+               
+- share/ contains translation, documentation, rings and hello sound files.
+