diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..fa1222ef --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +ConsumerSocket/ProducerTransport API: data transport library for ICN +==================================================== +This library is designed to provide a transport layer for applications willing to communicate +using an ICN protocol stack. It also provides some useful tools showing how to use the library. + +Dependencies +------------ + +- libboost-all-dev +- libparc +- libccnx-common +- long-bow + +Build the library +----------------- + +For building the library, from the root folder of the project: + +```bash + $ mkdir build && cd build + $ cmake .. + $ make +``` + +If you do not want to build the tools: + +```bash + $ mkdir build && cd build + $ cmake -D BUILD_TESTS=OFF .. + $ make +``` + +Install the library +------------------- + +For installing the library: + +```bash + $ cd build + $ sudo make install +```
\ No newline at end of file |