blob: fc74ebfe901a5e6bf3207d8cf28e6d7a97f3d3fe [file] [log] [blame]
NDN-CPP: A Named Data Networking client library for C++ and C
-------------------------------------------------------------
Prerequisites
-------------
Required: libcrypto
Optional: libsqlite3 (for key storage)
Optional: OSX Security framework (for key storage)
Following are the detailed steps for each platform to install the prerequisites.
* Ubuntu 12.04
sudo apt-get install build-essential
sudo apt-get install libssl-dev
* Windows Cygwin
Cygwin is tested on Windows 7 64-bit with the "Devel" packages selected to install at the top level of the
cygwin installer. This includes libcrypto and libsqlite3.
Build
-----
To build in a terminal, change directory to the ndn-cpp root. Enter:
./configure
make
make install
To make documentation, enter:
make doxygen-doc
Files
-----
This makes the following libraries:
.libs/libndn-c.a: The core C code for encoding and communication.
.libs/libndn-cpp.a: The C++ library API. (If linking to libndn-cpp, don't link to libndn-c since it is included.)
This makes the following test files:
bin/test-get-async: Connect to one of the NDN testbed hubs, express an interest and display the received data.
bin/test-encode-decode-interest: Encode and decode an interest, testing interest selectors and the name URI.
bin/test-encode-decode-data: Encode and decode a data packet, including signing the data packet.
bin/test-encode-decode-forwarding-entry: Encode and decode a data packet, including signing the data packet.
Running make doxygen-doc puts code documentation in:
doc/html
Supported platforms
-------------------
NDN-CPP is tested on the following platforms:
Ubuntu 12.04 (gcc 4.6.3)
Mac OS X 10.8.4 (clang 4.2)
Mac OS X 10.8.4 (gcc 4.2)