| Jeff Thompson | 9b282e0 | 2013-08-09 17:13:38 -0700 | [diff] [blame] | 1 | NDN-CPP: A Named Data Networking client library for C++ and C |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 2 | ------------------------------------------------------------- |
| 3 | |
| 4 | Prerequisites |
| 5 | ------------- |
| 6 | |
| Jeff Thompson | c2da8c7 | 2013-10-10 16:30:25 -0700 | [diff] [blame] | 7 | Required: libcrypto |
| 8 | Optional: libsqlite3 (for key storage) |
| 9 | Optional: OSX Security framework (for key storage) |
| 10 | |
| 11 | Following are the detailed steps for each platform to install the prerequisites. |
| 12 | |
| 13 | * Ubuntu 12.04 |
| 14 | sudo apt-get install build-essential |
| 15 | sudo apt-get install libssl-dev |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 16 | |
| Jeff Thompson | 1fd7365 | 2013-10-23 16:42:03 -0700 | [diff] [blame^] | 17 | * Windows Cygwin |
| 18 | Cygwin is tested on Windows 7 64-bit with the "Devel" packages selected to install at the top level of the |
| 19 | cygwin installer. This includes libcrypto and libsqlite3. |
| 20 | |
| 21 | |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 22 | Build |
| 23 | ----- |
| 24 | |
| 25 | To build in a terminal, change directory to the ndn-cpp root. Enter: |
| 26 | |
| 27 | ./configure |
| 28 | make |
| Jeff Thompson | c2da8c7 | 2013-10-10 16:30:25 -0700 | [diff] [blame] | 29 | make install |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 30 | |
| Jeff Thompson | 2f951cf | 2013-08-11 16:04:09 -0700 | [diff] [blame] | 31 | To make documentation, enter: |
| 32 | make doxygen-doc |
| 33 | |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 34 | Files |
| 35 | ----- |
| 36 | |
| 37 | This makes the following libraries: |
| 38 | |
| 39 | .libs/libndn-c.a: The core C code for encoding and communication. |
| Jeff Thompson | c2da8c7 | 2013-10-10 16:30:25 -0700 | [diff] [blame] | 40 | .libs/libndn-cpp.a: The C++ library API. (If linking to libndn-cpp, don't link to libndn-c since it is included.) |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 41 | |
| 42 | This makes the following test files: |
| 43 | |
| 44 | bin/test-get-async: Connect to one of the NDN testbed hubs, express an interest and display the received data. |
| 45 | bin/test-encode-decode-interest: Encode and decode an interest, testing interest selectors and the name URI. |
| 46 | bin/test-encode-decode-data: Encode and decode a data packet, including signing the data packet. |
| Jeff Thompson | c2da8c7 | 2013-10-10 16:30:25 -0700 | [diff] [blame] | 47 | bin/test-encode-decode-forwarding-entry: Encode and decode a data packet, including signing the data packet. |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 48 | |
| Jeff Thompson | 2f951cf | 2013-08-11 16:04:09 -0700 | [diff] [blame] | 49 | Running make doxygen-doc puts code documentation in: |
| 50 | doc/html |
| 51 | |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 52 | Supported platforms |
| 53 | ------------------- |
| 54 | |
| Jeff Thompson | 9b282e0 | 2013-08-09 17:13:38 -0700 | [diff] [blame] | 55 | NDN-CPP is tested on the following platforms: |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 56 | Ubuntu 12.04 (gcc 4.6.3) |
| 57 | Mac OS X 10.8.4 (clang 4.2) |
| 58 | Mac OS X 10.8.4 (gcc 4.2) |
| 59 | |
| 60 | |