blob: 900e839e301da7df5e384fd36db7c93fb1ccdfa7 [file] [log] [blame]
Vince Lehmanb722b102014-08-24 16:33:49 -05001NLSR Installation Instructions
2==============================
3
4.. toctree::
5..
6
7Prerequisites
8-------------
9
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070010- `NFD <http://named-data.net/doc/NFD/current/>`_ and its requirements:
Vince Lehmanb722b102014-08-24 16:33:49 -050011
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070012Refer to `Getting started with NFD <http://named-data.net/doc/NFD/current/INSTALL.html>`_
13for detailed installation and running instruction.
Vince Lehmanb722b102014-08-24 16:33:49 -050014
15- log4cxx library
16
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070017 On Ubuntu Linux:
Vince Lehmanb722b102014-08-24 16:33:49 -050018
19 ::
20
21 sudo apt-get install liblog4cxx10-dev
22
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070023 On OS X with MacPorts:
Vince Lehmanb722b102014-08-24 16:33:49 -050024
25 ::
26
27 sudo port install log4cxx
28
29- protobuf
30
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070031 On Ubuntu Linux:
Vince Lehmanb722b102014-08-24 16:33:49 -050032
33 ::
34
35 sudo apt-get install libprotobuf-dev protobuf-compiler
36
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070037 On OS X with MacPorts:
Vince Lehmanb722b102014-08-24 16:33:49 -050038
39 ::
40
41 sudo port install protobuf-cpp
42
43Build
44-----
45
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070046Execute the following commands to build NLSR:
Vince Lehmanb722b102014-08-24 16:33:49 -050047
48::
49
50 ./waf configure
51 ./waf
52 sudo ./waf install
53
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070054Refer to ``./waf help`` for more options that can be used during the configure stage and
55how to properly configure NLSR.
Vince Lehmanb722b102014-08-24 16:33:49 -050056
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070057If your pkgconfig path is not set properly you can do following before running ``./waf
58configure``
Vince Lehmanb722b102014-08-24 16:33:49 -050059
60::
61
62 export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/
63 or
64 export PKG_CONFIG_PATH=/path/to/pkgconfig/in/your/machine