blob: 63f3c87fa664012b51ef84d2d7912b3cde279bf9 [file] [log] [blame] [view]
Alexander Afanasyev08eecea2014-03-28 10:23:30 -07001NFD: NDN Forwarding Daemon
2==========================
Alexander Afanasyev2aa39622014-01-22 11:51:11 -08003
Junxiao Shi336e4f72014-01-22 19:38:31 -07004## Prerequisites
Alexander Afanasyev2aa39622014-01-22 11:51:11 -08005
Alexander Afanasyev08eecea2014-03-28 10:23:30 -07006* [ndn-cpp-dev library](https://github.com/named-data/ndn-cpp-dev) and
7 its requirements:
8
9 * `libcrypto`
10 * `libsqlite3`
11 * `libcrypto++`
12 * `pkg-config`
13 * Boost libraries (>= 1.48)
14 * OSX Security framework (on OSX platform only)
15
16 Refer to https://github.com/named-data/ndn-cpp-dev/blob/master/INSTALL.md
17 for detailed installation instructions.
18
19* `libpcap`
20
21 Comes with base on Mac OS X 10.8 and 10.9:
22
23 On Ubuntu >= 12.04:
24
25 sudo apt-get install libpcap-dev
26
27To build API documentation:
28
29* `doxygen`
30
31 On Mac OS X 10.8 and 10.9 with macports:
32
33 sudo port install doxygen
34
35 On Ubuntu >= 12.04:
36
37 sudo apt-get install doxygen
Alexander Afanasyev2aa39622014-01-22 11:51:11 -080038
Junxiao Shi336e4f72014-01-22 19:38:31 -070039## Build
Alexander Afanasyev2aa39622014-01-22 11:51:11 -080040
41The following commands should be used to build NFD:
42
43 ./waf configure
44 ./waf
Alexander Afanasyev2aa39622014-01-22 11:51:11 -080045 sudo ./waf install
46
Alexander Afanasyev08eecea2014-03-28 10:23:30 -070047Refer to `README.md` file for more options that can be used during `configure` stage and how to properly configure and run NFD.
Alexander Afanasyev2aa39622014-01-22 11:51:11 -080048
Alexander Afanasyev08eecea2014-03-28 10:23:30 -070049In some configurations, configuration step may require small modification:
50
51 export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/lib/pkgconfig:/usr/lib64/pkgconfig
52 ./waf configure
53 ./waf
54 sudo ./waf install