fork of pjproject; contains code relevant to ongoing sysmocom developments.
Go to file
Benny Prijono 3e6e7165a6 Fix warning messages in GSM and speex because of previous update to GSM patchlevel 10 and speex 1.1.12
git-svn-id: https://svn.pjsip.org/repos/pjproject/trunk@524 74dad513-b988-da41-8d7b-12977e46ad98
2006-06-19 12:09:54 +00:00
build Added README-RTEMS and tweaked the makefiles 2006-05-27 13:11:32 +00:00
pjlib Set log message level to error (=1) when message is too long 2006-06-19 12:08:27 +00:00
pjlib-util Added README-RTEMS and tweaked the makefiles 2006-05-27 13:11:32 +00:00
pjmedia Fix warning messages in GSM and speex because of previous update to GSM patchlevel 10 and speex 1.1.12 2006-06-19 12:09:54 +00:00
pjsip Increase default max SIP packet size to 2000 (from 1500), since SIP PDU containing presence info can be quite large 2006-06-19 12:06:02 +00:00
pjsip-apps Comment out PJSUA options that are no longer supported with new pjsua 2006-06-19 12:07:44 +00:00
COPYING Pretty comments 2005-11-18 00:16:43 +00:00
INSTALL.txt Put few words in INSTALL.txt and README.txt 2006-03-02 21:52:18 +00:00
Makefile Updated root Makefile, defined $TARGET as shortcut for ($MACHINE_NAME-$OS_NAME-$CC_NAME) 2006-05-04 08:57:45 +00:00
README-RTEMS Added README-RTEMS and tweaked the makefiles 2006-05-27 13:11:32 +00:00
README-configure Merge-in RTEMS port patch by Phil Torre <ptorre@zetron.com>, alpha release. 2006-05-10 19:24:40 +00:00
README.txt Updated README.txt 2006-03-09 16:19:20 +00:00
configure Fixed MacOS X build 2006-05-21 23:20:54 +00:00
svn_add Added svn_pset 2006-02-09 09:30:31 +00:00
svn_pset Added svn_pset 2006-02-09 09:30:31 +00:00

README.txt

See INSTALL.txt for compiling.


TOP LEVEL DIRECTORIES
======================
Below is the descriptions of the top-level directories:

-root
 -build..................... Makefiles includes, nothing interesting to see except
                             when porting to new platforms.
 -pjlib..................... Base library used by all other libraries.  It contains 
                             platform abstraction, data structures, etc. 
 -pjlib-util................ Utilities, such as text scanner, XML parser, etc.
 -pjmedia................... Media framework, contains:
                              - pjmedia.......... the core media framework, which 
                                                  contains codec framework, streams,
                                                  stream ports, conference bridge,
                                                  RTP/RTCP, SDP, SDP negotiator, etc.
                              - pjmedia-codec.... the static library container for 
                                                  all codecs. For the moment, it
                                                  contains GSM and SPEEX codec.
 -pjsip..................... SIP stack, contains:
                              - pjsip............ The core SIP stack, which contains
                                                  endpoint, transport layer, message and
                                                  URI structures, transaction layer, 
                                                  UA layer and dialog, utilities, etc.
                              - pjsip-simple..... SIMPLE (+presence, IM), contains
                                                  basic event framework, presence, and
                                                  instant messaging.
                              - pjsip-ua......... SIP "call" abstraction, which blends
                                                  INVITE session and SDP negotiation.
                                                  Also contains call features such as
                                                  call transfer, and client side SIP
                                                  registration.
                              - pjsua-lib........ Very high level UA app. library,
                                                  which blends all functionalities
                                                  together in very easy to use API.
                                                  Good to build a powerfull softphone
                                                  very quickly.
 -pjsip-apps................ Contains some sample applications:
                              - pjsua............ A powerful, console based SIP
                                                  UA, based on pjsua-lib.
                              - pjsip-perf....... SIP performance tester or call 
                                                  generator.


SUB-DIRECTORY LAYOUT
======================
Each subdirectories normally would have this layout:

 -bin...................... The binaries resulted from the build process will
                            go here.
 -build.................... Makefile and project files.
 -docs..................... Documentation specific to the project and doxygen config file
                            to generate documentation from the source code.
 -include.................. Header files.
 -lib...................... The static libraries resulted from the build process
                            will go here.
 -src...................... Source files.


YOUR EDITOR SETTINGS ARE IMPORTANT!
====================================
You need to set your editor settings to tab=8 and indent=4. For example,
with vim, you can do this with:
 :se ts=8
 :se sts=4