Add function to calculate IPv6 address from MAC
[oonf.git] / README.md
1 # How to Install
2
3 See http://www.olsr.org/mediawiki/index.php/OLSR.org_Network_Framework for a longer explanation. This README is the short version.
4
5 ## Installing from source
6
7 Get your code from the OLSR.org Network Framework GitHub:
8 (see https://github.com/OLSR/OONF)
9
10  * ``git clone https://github.com/OLSR/OONF.git``
11
12 ### Pre-requisites
13
14 Download and install the neccessary build requirements
15 (see http://www.olsr.org/mediawiki/index.php/OLSR.org_Network_Framework#Requirements)
16
17 For Debian you will mostly need the following ones:
18   * cmake: ``sudo apt-get install cmake``
19   * build-essentials: ``sudo apt-get install build-essential libnl-3-dev``
20
21 ## Compiling
22   * ``cd build``
23   * ``cmake ..``
24   * ``make``
25
26 ## Configuring OLSRv2
27
28 ## Starting OLSRv2
29
30 Assuming your interfaces you want olsrd2 to listen on are ``eth0, wlan0 and lo`` you could start it like this:
31
32   * ``sudo ./olsrd2_static eth0 wlan0 lo``
33
34 You won't see much output though. You can enable more output (by default it comes on stderr) for several subsystems. You can get a list of these subsystems with:
35
36   * ``./olsrd2_static --schema=log.info``
37   * ``./olsrd2_static --schema=log.debug``
38
39 This shows you which info and debug schemas exist. Let's say we are interested in the neighborhood disovery protocol (NHDP, RFC6130, "Hello messages"). We can set this subsystem writing actions to debug level via:
40
41   * ``sudo ./olsrd2_static --set=log.debug=nhdp_w eth0 wlan0  lo``
42
43 You should now see some output which shows you the info from the hello packets.
44
45 ## How to proceed from here
46
47 If you managed to start olsrd2 and see some output, you made it! Now is the time to review the detailed configuration setups at http://www.olsr.org/mediawiki/index.php/OLSR_network_deployments