blob: d719c993300d20e6a9369bae3ed41e198b9d69ad [file] [log] [blame]
Jeff Thompson9b282e02013-08-09 17:13:38 -07001NDN-CPP: A Named Data Networking client library for C++ and C
Jeff Thompson057d3182013-08-09 17:02:25 -07002-------------------------------------------------------------
3
4Prerequisites
5-------------
6
7libcrypto
8
9Build
10-----
11
12To build in a terminal, change directory to the ndn-cpp root. Enter:
13
14./configure
15make
16
17(There is currently no "install" step.)
18
Jeff Thompson2f951cf2013-08-11 16:04:09 -070019To make documentation, enter:
20make doxygen-doc
21
Jeff Thompson057d3182013-08-09 17:02:25 -070022Files
23-----
24
25This makes the following libraries:
26
27.libs/libndn-c.a: The core C code for encoding and communication.
28.libs/libndn-cpp.a: The C++ library API. libndn-cpp also needs libndn-c.
29
30This makes the following test files:
31
32bin/test-get-async: Connect to one of the NDN testbed hubs, express an interest and display the received data.
33bin/test-encode-decode-interest: Encode and decode an interest, testing interest selectors and the name URI.
34bin/test-encode-decode-data: Encode and decode a data packet, including signing the data packet.
35
Jeff Thompson2f951cf2013-08-11 16:04:09 -070036Running make doxygen-doc puts code documentation in:
37doc/html
38
Jeff Thompson057d3182013-08-09 17:02:25 -070039Supported platforms
40-------------------
41
Jeff Thompson9b282e02013-08-09 17:13:38 -070042NDN-CPP is tested on the following platforms:
Jeff Thompson057d3182013-08-09 17:02:25 -070043Ubuntu 12.04 (gcc 4.6.3)
44Mac OS X 10.8.4 (clang 4.2)
45Mac OS X 10.8.4 (gcc 4.2)
46
47