summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMauro Sardara <msardara+fdio@cisco.com>2017-02-22 14:37:37 +0100
committerMauro Sardara <msardara+fdio@cisco.com>2017-02-22 13:46:08 +0000
commitba8541cad3a4069886444abbd1848b6ef3fff72c (patch)
tree39226dd9b036ca7e513c2cccd8e71e15e09b86bc /README.md
parent9b30fc10fb1cbebe651e5a107e8ca5b24de54675 (diff)
Initial Commit: libicnet
Change-Id: I10a72cb0d84b76553a85c168416b847f6a4ff5f6 Signed-off-by: Mauro Sardara <msardara+fdio@cisco.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
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