Ignore:
Timestamp:
Mar 9, 2006 4:19:20 PM (18 years ago)
Author:
bennylp
Message:

Updated README.txt

File:
1 edited

Legend:

Unmodified
Added
Removed

  • pjproject/trunk/README.txt

    r285 r314  
    1 PJPROJECT is released under GPL. License information can be found in file  
    2 COPYING in this directory. For alternative licensing, please contact the 
    3 copyright holder. 
    41 
    52See INSTALL.txt for compiling. 
    63 
    7 IMPORTANT: 
     4 
     5TOP LEVEL DIRECTORIES 
     6====================== 
     7Below is the descriptions of the top-level directories: 
     8 
     9-root 
     10 -build..................... Makefiles includes, nothing interesting to see except 
     11                             when porting to new platforms. 
     12 -pjlib..................... Base library used by all other libraries.  It contains  
     13                             platform abstraction, data structures, etc.  
     14 -pjlib-util................ Utilities, such as text scanner, XML parser, etc. 
     15 -pjmedia................... Media framework, contains: 
     16                              - pjmedia.......... the core media framework, which  
     17                                                  contains codec framework, streams, 
     18                                                  stream ports, conference bridge, 
     19                                                  RTP/RTCP, SDP, SDP negotiator, etc. 
     20                              - pjmedia-codec.... the static library container for  
     21                                                  all codecs. For the moment, it 
     22                                                  contains GSM and SPEEX codec. 
     23 -pjsip..................... SIP stack, contains: 
     24                              - pjsip............ The core SIP stack, which contains 
     25                                                  endpoint, transport layer, message and 
     26                                                  URI structures, transaction layer,  
     27                                                  UA layer and dialog, utilities, etc. 
     28                              - pjsip-simple..... SIMPLE (+presence, IM), contains 
     29                                                  basic event framework, presence, and 
     30                                                  instant messaging. 
     31                              - pjsip-ua......... SIP "call" abstraction, which blends 
     32                                                  INVITE session and SDP negotiation. 
     33                                                  Also contains call features such as 
     34                                                  call transfer, and client side SIP 
     35                                                  registration. 
     36                              - pjsua-lib........ Very high level UA app. library, 
     37                                                  which blends all functionalities 
     38                                                  together in very easy to use API. 
     39                                                  Good to build a powerfull softphone 
     40                                                  very quickly. 
     41 -pjsip-apps................ Contains some sample applications: 
     42                              - pjsua............ A powerful, console based SIP 
     43                                                  UA, based on pjsua-lib. 
     44                              - pjsip-perf....... SIP performance tester or call  
     45                                                  generator. 
     46 
     47 
     48SUB-DIRECTORY LAYOUT 
     49====================== 
     50Each subdirectories normally would have this layout: 
     51 
     52 -bin...................... The binaries resulted from the build process will 
     53                            go here. 
     54 -build.................... Makefile and project files. 
     55 -docs..................... Documentation specific to the project and doxygen config file 
     56                            to generate documentation from the source code. 
     57 -include.................. Header files. 
     58 -lib...................... The static libraries resulted from the build process 
     59                            will go here. 
     60 -src...................... Source files. 
     61 
     62 
     63YOUR EDITOR SETTINGS ARE IMPORTANT! 
     64==================================== 
    865You need to set your editor settings to tab=8 and indent=4. For example, 
    966with vim, you can do this with: 
    1067 :se ts=8 
    1168 :se sts=4 
     69 
     70 
Note: See TracChangeset for help on using the changeset viewer.