blob: da66e87db3ab7ac4abe39aa5a7a8d5bbe092b318 [file] [log] [blame]
Vince Lehmanb722b102014-08-24 16:33:49 -05001NLSR Installation Instructions
2==============================
3
4.. toctree::
5..
6
7Prerequisites
8-------------
9
Alexander Afanasyev67758b12018-03-06 18:36:44 -050010- `NFD <https://named-data.net/doc/NFD/>`_ and its requirements:
Vince Lehmanb722b102014-08-24 16:33:49 -050011
Alexander Afanasyev67758b12018-03-06 18:36:44 -050012Refer to `Getting started with NFD <https://named-data.net/doc/NFD/current/INSTALL.html>`_
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070013for detailed installation and running instruction.
Vince Lehmanb722b102014-08-24 16:33:49 -050014
David Arjona2fa23ea2018-11-28 11:50:38 -060015- ChronoSync library:
16
17Download the ChronoSync library and build it according to the instructions at the following
18address:
Ashlesh Gawande415676b2016-12-22 00:26:23 -060019
20 ::
21
22 https://github.com/named-data/ChronoSync#build
23
Ashlesh Gawande32ec3fd2018-07-18 13:42:32 -050024- PSync library:
25
26Download the PSync library and build it according to the instructions at the following
27address:
28
29 ::
30
31 https://github.com/named-data/PSync#build
32
Vince Lehmanb722b102014-08-24 16:33:49 -050033Build
34-----
35
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070036Execute the following commands to build NLSR:
Vince Lehmanb722b102014-08-24 16:33:49 -050037
38::
39
40 ./waf configure
41 ./waf
42 sudo ./waf install
43
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070044Refer to ``./waf help`` for more options that can be used during the configure stage and
45how to properly configure NLSR.
Vince Lehmanb722b102014-08-24 16:33:49 -050046
Vince Lehman59dfac32015-04-29 12:37:26 -050047If your pkgconfig path is not set properly you can do the following before running ``./waf
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070048configure``
Vince Lehmanb722b102014-08-24 16:33:49 -050049
50::
51
52 export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/
53 or
Vince Lehman59dfac32015-04-29 12:37:26 -050054 export PKG_CONFIG_PATH=/path/to/pkgconfig/on/your/machine