Changeset 10705 for INSTALL


Ignore:
Timestamp:
Aug 27, 2012, 6:29:50 PM (12 years ago)
Author:
Michael Tänzer
Message:

Install documentation: minor improvements

File:
1 edited

Legend:

Unmodified
Added
Removed
  • INSTALL

    r10700 r10705  
    2525
    2626
    27 Quick Install (If all dependencies are satisfied)
     27Quick Install
    2828=============
    2929
     
    3333
    3434Download the latest ariba package from the the download site
    35 http://ariba-underlay.org/downloads or get the latest trunk code:
    36 > svn co https://svn.tm.kit.edu/SpoVNet-KA/entwicklung/ariba/trunk ariba-trunk
     35http://ariba-underlay.org/downloads:
    3736
    38 If you downloaded ariba from the website extract the archive and change into the
    39 project directory:
     37Extract the archive and change into the project directory:
    4038> tar xfz ./ariba-x.x.x.tar.gz
    4139> cd ariba-x.x.x
    4240
    43 For SVN checkout you have to:
     41Alternatively, you could try to use the latest development code from our SVN
     42trunk (attention: the code on trunk might break from time to time):
     43> svn co https://svn.tm.kit.edu/SpoVNet-KA/entwicklung/ariba/trunk ariba-trunk
    4444> cd ariba-trunk
    4545
     
    5454HINT: you may use
    5555> make -j 2
    56 for a double processor/core system to speed up the compilation,
     56for a dual processor/core system to speed up the compilation,
    5757make -j 4 if you have quad-core respectively, and so on. If
    5858the compilation stops, try make without the -j option again.
     
    8686CMAKE_BUILD_TYPE     - One of "", "Release", "Debug", "RelWithDebInfo" or
    8787                       "MinSizeRel". This influences the build in various ways
    88                        (e.g. which compiler optimizations are turned on, whether
    89                        debug symbols are included, what warnings to show).
     88                       (which compiler optimizations are turned on, whether
     89                       debug symbols are included, what warnings to show etc.).
    9090
    9191ENABLE_{AVAHI,BLUETOOTH,LOG4CXX}
     
    120120
    121121
     122Building the Documentation
     123==========================
     124To build the documentation once you can build the "docu" target:
     125> make docu
     126
     127If you want to build the documentation on every build you can enable the
     128ALWAYS_BUILD_DOCUMENTATION option in CMake.
     129
     130
    122131Running the PingPong Sample
    123132===========================
     
    130139> ./sample/pingpong/pingpong ../etc/pingpong/settings_node1.cnf
    131140
    132 If this fails to find the libariba you may have to set the LD_LIBRARY_PATH
    133 correctly in your current terminal, or better add it to your .bashrc
    134 > export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/user/ariba/build/source/ariba
    135 
    136141When running the pingpong application it will output a large number of log
    137142messages and the initiator will wait for other nodes to join. You can start them
     
    143148Once the PingPong sample is running and the nodes have connected, each node will
    144149send out ping messages to every node he knows in the overlay structure every
    145 5 seconds. You can now e.g. test mobility of Ariba and change the IP address of
    146 a node, or swith from LAN connection to WLAN. The links established by the
    147 PingPong sample through Ariba are mobility invariant and automatically repaired.
     1505 seconds. You can now e.g. test mobility of ariba and change the IP address of
     151a node, or switch from LAN connection to WLAN. The links established by the
     152PingPong sample through ariba are mobility invariant and automatically repaired.
    148153
    149154
    150155Cross-Compiling for Maemo
    151156=========================
    152 Ariba runs on Nokia Maemo 4 (tested) and probably Maemo 5. We have tested Ariba
     157Ariba runs on Nokia Maemo 4 (tested) and probably Maemo 5. We have tested ariba
    153158on an N810 device. Cross-Compiling is done using Scratchbox. Use the
    154159preassembled Scratchbox version provided by Nokia which will install and
Note: See TracChangeset for help on using the changeset viewer.