blob: f3c0ed63c4b1c3ac5d44fe0d164539c3fa1f10da [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
Vince Lehman59dfac32015-04-29 12:37:26 -050043- openssl
44
45 On Ubuntu Linux:
46
47 ::
48
49 sudo apt-get install libssl-dev
50
51 On OS X with MacPorts:
52
53 ::
54
55 sudo port install openssl
56
Vince Lehmanb722b102014-08-24 16:33:49 -050057Build
58-----
59
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070060Execute the following commands to build NLSR:
Vince Lehmanb722b102014-08-24 16:33:49 -050061
62::
63
64 ./waf configure
65 ./waf
66 sudo ./waf install
67
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070068Refer to ``./waf help`` for more options that can be used during the configure stage and
69how to properly configure NLSR.
Vince Lehmanb722b102014-08-24 16:33:49 -050070
Vince Lehman59dfac32015-04-29 12:37:26 -050071If your pkgconfig path is not set properly you can do the following before running ``./waf
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070072configure``
Vince Lehmanb722b102014-08-24 16:33:49 -050073
74::
75
76 export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/
77 or
Vince Lehman59dfac32015-04-29 12:37:26 -050078 export PKG_CONFIG_PATH=/path/to/pkgconfig/on/your/machine