Changeset 787


Ignore:
Timestamp:
Oct 21, 2006 6:28:07 PM (14 years ago)
Author:
bennylp
Message:

Updated README.txt

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pjproject/trunk/README.txt

    r710 r787  
    1  
    21 
    32Getting Started: Building and Using PJSIP and PJMEDIA 
    43 
    5    [Last Update: Sept 13, 2006] 
     4   [Last Update: $Date: 2006-10-21 19:14:22 +0100 (Sat, 21 Oct 2006) $] 
     5 
    66     _________________________________________________________________ 
    77 
     
    1212 
    1313Quick Info 
    14  
    15    Building with GNU tools 
     14     _________________________________________________________________ 
     15 
     16   Building with GNU tools (Linux, *BSD, MacOS X, mingw, etc.) 
    1617          Generally these should be all that are needed to build the libraries, 
    1718          applications, and samples: 
    1819 
    19    $ ./configure 
    20    $ make dep && make clean && make 
     20           $ ./configure 
     21           $ make dep && make clean && make 
    2122 
    2223   Building Win32 Target with Microsoft Visual Studio 
     
    3435         3. build the pjsua_wince application. 
    3536 
    36    With Visual Studio for Win32 target and the GNU build systems, the output 
    37    libraries will be put in lib directory under each projects, and the output 
    38    binaries will be put in bin directory under each projects. 
     37   Locating Output Binaries/Libraries 
     38          Libraries will be put in lib directory, and binaries will be put in 
     39          bin directory, under each projects. 
     40 
     41   Running the Applications 
     42          After successful build, you can try running pjsua application on 
     43          pjsip-apps/bin     directory.     PJSUA     manual     is    in 
     44          http://www.pjsip.org/pjsua.htm. 
    3945 
    4046 
     
    5662     2.2 Disk Space Requirements 
    5763 
    58    3. Building Linux, *nix, *BSD, and MacOS X Targets with GNU Build Systems 
     64   3.  Building Linux, *nix, *BSD, and MacOS X Targets with GNU Build 
     65   Systems 
    5966 
    6067     3.1 Supported Targets 
     
    6774 
    6875     3.5 Cross Compilation 
     76 
     77     3.6 Build Customizations 
    6978 
    7079   4. Building for Windows Targets with Microsoft Visual Studio 
     
    277286     _________________________________________________________________ 
    278287 
    279 2.1 config_site.h file 
    280      _________________________________________________________________ 
     2882.1 Create config_site.h file 
     289     _________________________________________________________________ 
     290 
     291   Before source files can be built, the pjlib/include/pj/config_site.h file 
     292   must be created (it can just be an empty file). 
     293 
     294   Note: 
     295          When the Makefile based build system is used, this process is taken 
     296          care by the Makefiles. But when non-Makefile based build system (such 
     297          as Visual Studio) is used, the config_site.h file must be created 
     298          manually. 
     299 
     300 
     301What is config_site.h File 
    281302 
    282303   The pjlib/include/pj/config_site.h contains local customizations to the 
     
    294315   Please find list of configuration macros that can be overriden from these 
    295316   files: 
    296      * pjlib/config.h file 
    297      * pjmedia/config.h file 
    298      * pjsip/sip_config.h file 
     317     * PJLIB Configuration (the pjlib/config.h file) 
     318     * PJLIB-UTIL Configuration (the pjlib-util/config.h file) 
     319     * PJMEDIA Configuration (the pjmedia/config.h file) 
     320     * PJSIP Configuration (the pjsip/sip_config.h file) 
    299321 
    300322   A     sample    config_site.h    file    is    also    available    in 
     
    323345 
    324346   The building process needs: 
    325      * about 50-60 MB of disk space to store the uncompressed source files, and 
     347   about 50-60 MB of disk space to store the uncompressed source files, and 
    326348     * about 30-50 MB of additional space for building each target 
    327349 
     
    416438   obtained by executing ./configure --help. 
    417439 
    418    For example, to build the libraries/application in debug mode: 
    419  
    420  
    421  
    422    $ ./configure CFLAGS="-g" 
     440   Below is an example of specifying CFLAGS in configure: 
     441 
     442 
     443 
     444   $ ./configure CFLAGS="-O3 -DNDEBUG -msoft-float -fno-builtin" 
    423445   ... 
    424446 
     
    427449     _________________________________________________________________ 
    428450 
    429    (.. to be completed) 
    430  
    431  
    432  
    433    $ ./configure --target=powerpc-linux-unknown 
     451   Cross compilation should be supported, using the usual autoconf syntax: 
     452 
     453 
     454 
     455   $ ./configure --host=arm-elf-linux 
    434456   ... 
     457 
     458   Since cross-compilation is not tested as often as the "normal" build, please 
     459   watch for the ./configure output for incorrect settings (well ideally this 
     460   should be done for normal build too). 
     461 
     462   Please refer to Porting Guide for further information about porting PJ 
     463   software. 
    435464 
    436465 
     
    474503 
    475504 
     505  3.6 Build Customizations 
     506     _________________________________________________________________ 
     507 
     508   Build features can be customized by specifying the options when running 
     509   ./configure as described in Running Configure above. 
     510 
     511   In addition, additional CFLAGS and LDFLAGS options can be put in user.mak 
     512   file in PJ root directory (this file may need to be created if it doesn't 
     513   exist). Below is a sample of user.mak file contents: 
     514 
     515 
     516 
     517   export CFLAGS += -msoft-float -fno-builtin 
     518   export LDFLAGS += 
     519 
     520 
    4765214. Building for Windows Targets with Microsoft Visual Studio 
    477522     _________________________________________________________________ 
     
    486531     * Microsoft Visual Studio .NET 2002, 
    487532     * Microsoft Visual Studio .NET 2003, 
    488      * Microsoft Visual C++ Express 2005 with Platform SDK and DirectX SDK, 
     533     * Microsoft Visual C++ Express 2005 with Platform SDK, 
     534     * DirectX SDK is needed if PJMEDIA DirectSound sound backend is explicitly 
     535       choosen (default is using PortAudio, which uses DirectSound via run-time 
     536       bindings, so DirectX SDK is not needed) 
    489537 
    490538   For the host, the following are required: 
     
    699747 
    700748 
     749    6. Link with system spesific libraries: 
     750 
     751        Windows 
     752                Add (among other things): wsock32.lib, ws2_32.lib, ole32.lib, 
     753                dsound.lib 
     754 
     755        Linux, *nix, *BSD 
     756                Add (among other things): '-lpthread -lm' (at least). 
     757 
     758        MacOS X 
     759                Add (among other things): '-framework CoreAudio -lpthread -lm'. 
     760 
     761 
    701762Appendix I: Common Problems/Frequently Asked Question (FAQ) 
    702763     _________________________________________________________________ 
     
    713774 
    714775 
    715   Thanks for using PJ libraries and for reading this document. Please 
    716   send feedbacks or general comments to <bennylp at pjsip dot org>. 
    717  
    718   Benny Prijono 
    719  
     776 
     777 
     778 
     779     _________________________________________________________________ 
     780 
     781   Feedback: 
     782          Thanks for using PJ libraries and for reading this document. Please 
     783          send feedbacks or general comments to <bennylp at pjsip dot org>. 
     784 
Note: See TracChangeset for help on using the changeset viewer.