blob: f4969198552bcc8b7a2caede4807ca54dfc6304d [file] [log] [blame]
Vince Lehmanb722b102014-08-24 16:33:49 -05001NLSR Installation Instructions
2==============================
3
4.. toctree::
5..
6
7Prerequisites
8-------------
9
Davide Pesaventof6be8e32020-04-30 16:06:03 -040010- `NFD <https://named-data.net/doc/NFD/>`_ and its dependencies
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
Davide Pesaventof6be8e32020-04-30 16:06:03 -040015- ChronoSync library
David Arjona2fa23ea2018-11-28 11:50:38 -060016
Davide Pesaventof6be8e32020-04-30 16:06:03 -040017Download the ChronoSync library and build it according to the instructions available at
18https://github.com/named-data/ChronoSync#build
Ashlesh Gawande415676b2016-12-22 00:26:23 -060019
Davide Pesaventof6be8e32020-04-30 16:06:03 -040020- PSync library
Ashlesh Gawande415676b2016-12-22 00:26:23 -060021
Davide Pesaventof6be8e32020-04-30 16:06:03 -040022Download the PSync library and build it according to the instructions available at
23https://github.com/named-data/PSync#build
Ashlesh Gawande32ec3fd2018-07-18 13:42:32 -050024
Vince Lehmanb722b102014-08-24 16:33:49 -050025Build
26-----
27
Davide Pesaventof6be8e32020-04-30 16:06:03 -040028Execute the following commands to build NLSR::
Vince Lehmanb722b102014-08-24 16:33:49 -050029
30 ./waf configure
31 ./waf
32 sudo ./waf install
33
Davide Pesaventof6be8e32020-04-30 16:06:03 -040034Refer to ``./waf --help`` for more options that can be used during the configure stage and
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -070035how to properly configure NLSR.
Vince Lehmanb722b102014-08-24 16:33:49 -050036
Vince Lehman59dfac32015-04-29 12:37:26 -050037If your pkgconfig path is not set properly you can do the following before running ``./waf
Davide Pesaventof6be8e32020-04-30 16:06:03 -040038configure``::
Vince Lehmanb722b102014-08-24 16:33:49 -050039
Davide Pesaventof6be8e32020-04-30 16:06:03 -040040 export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
41 # or
Vince Lehman59dfac32015-04-29 12:37:26 -050042 export PKG_CONFIG_PATH=/path/to/pkgconfig/on/your/machine