Changeset 10705

Timestamp:

Aug 27, 2012, 6:29:50 PM (12 years ago)

Author:

Michael Tänzer

Message:

Install documentation: minor improvements

File:

• INSTALL (modified) (7 diffs)

INSTALL

@@ -25 +25 @@
 
 
-Quick Install (If all dependencies are satisfied)
+Quick Install
 =============
 
@@ -33 +33 @@
 
 Download the latest ariba package from the the download site
-http://ariba-underlay.org/downloads or get the latest trunk code:
-> svn co https://svn.tm.kit.edu/SpoVNet-KA/entwicklung/ariba/trunk ariba-trunk
+http://ariba-underlay.org/downloads:
 
-If you downloaded ariba from the website extract the archive and change into the
-project directory:
+Extract the archive and change into the project directory:
 > tar xfz ./ariba-x.x.x.tar.gz
 > cd ariba-x.x.x
 
-For SVN checkout you have to: 
+Alternatively, you could try to use the latest development code from our SVN
+trunk (attention: the code on trunk might break from time to time):
+> svn co https://svn.tm.kit.edu/SpoVNet-KA/entwicklung/ariba/trunk ariba-trunk
 > cd ariba-trunk
 
@@ -54 +54 @@
 HINT: you may use 
 > make -j 2 
-for a double processor/core system to speed up the compilation,
+for a dual processor/core system to speed up the compilation,
 make -j 4 if you have quad-core respectively, and so on. If 
 the compilation stops, try make without the -j option again.
@@ -86 +86 @@
 CMAKE_BUILD_TYPE     - One of "", "Release", "Debug", "RelWithDebInfo" or
                        "MinSizeRel". This influences the build in various ways
-                       (e.g. which compiler optimizations are turned on, whether
-                       debug symbols are included, what warnings to show).
+                       (which compiler optimizations are turned on, whether
+                       debug symbols are included, what warnings to show etc.).
 
 ENABLE_{AVAHI,BLUETOOTH,LOG4CXX}
@@ -120 +120 @@
 
 
+Building the Documentation
+==========================
+To build the documentation once you can build the "docu" target:
+> make docu
+
+If you want to build the documentation on every build you can enable the
+ALWAYS_BUILD_DOCUMENTATION option in CMake.
+
+
 Running the PingPong Sample
 ===========================
@@ -130 +139 @@
 > ./sample/pingpong/pingpong ../etc/pingpong/settings_node1.cnf
 
-If this fails to find the libariba you may have to set the LD_LIBRARY_PATH
-correctly in your current terminal, or better add it to your .bashrc
-> export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/user/ariba/build/source/ariba
-
 When running the pingpong application it will output a large number of log
 messages and the initiator will wait for other nodes to join. You can start them
@@ -143 +148 @@
 Once the PingPong sample is running and the nodes have connected, each node will
 send out ping messages to every node he knows in the overlay structure every
-5 seconds. You can now e.g. test mobility of Ariba and change the IP address of
-a node, or swith from LAN connection to WLAN. The links established by the
-PingPong sample through Ariba are mobility invariant and automatically repaired.
+5 seconds. You can now e.g. test mobility of ariba and change the IP address of
+a node, or switch from LAN connection to WLAN. The links established by the
+PingPong sample through ariba are mobility invariant and automatically repaired.
 
 
 Cross-Compiling for Maemo
 =========================
-Ariba runs on Nokia Maemo 4 (tested) and probably Maemo 5. We have tested Ariba
+Ariba runs on Nokia Maemo 4 (tested) and probably Maemo 5. We have tested ariba
 on an N810 device. Cross-Compiling is done using Scratchbox. Use the
 preassembled Scratchbox version provided by Nokia which will install and