summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 24 insertions, 10 deletions
diff --git a/README.md b/README.md
index c43dbb4ee..3b10574e3 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,10 @@ Hybrid Information-Centric Networking (hICN)
========================
## Introduction
-hicn is an open source implementation of Cisco's hICN. It includes a network
-stack, that implements ICN forwarding path in IPv6, and a transport stack
-that implements two main transport protocols and a socket API.
-The transport protocols provide one reliable transport service implementaton
-and a real-time transport service for audio/video media.
+hicn is an open source implementation of Cisco's hICN. It includes a network stack, that implements
+ICN forwarding path in IPv6, and a transport stack that implements two main transport protocols and
+a socket API. The transport protocols provide one reliable transport service implementaton and a
+real-time transport service for audio/video media.
## Directory layout
@@ -19,15 +18,30 @@ and a real-time transport service for audio/video media.
| utils | Tools for testing |
| apps | Application examples using hicn stack |
+hicn plugin is a VPP plugin that implement hicn packet processing as specified in
+https://datatracker.ietf.org/doc/draft-muscariello-intarea-hicn/. The transport library is used to
+implement the hicn host stack and makes use of libmemif as high performance connector between
+transport and the network stack. The transport library makes use of VPP binary API to configure the
+local namespace (local face management).
## Supported platforms
-- Ubuntu 16.04 LTS (x86_64)
-- Ubuntu 18.04 LTS (x86_64)
-- Debian Stable/Testing
-- Red Hat Enterprise Linux 7
-- CentOS 7
+- Ubuntu 16.04 LTS (amd64)
+- Ubuntu 18.04 LTS (amd64)
+- CentOS 7 (x86_64)
- Android 8
- iOS 12
- macOS 10.12
- Windows 10
+
+## Binaries
+# Ubuntu 16/18 (amd64) and CentOS 7 (x86_64)
+https://packagecloud.io/fdio/release
+
+## Release note
+The current master branch provides the 19.01 release which is compatible with the 19.01 VPP stable.
+No other VPP releases are supported nor maintained. At every new VPP release distribution hicn
+master branch is updated to work with the latest stable release. All previous stable releases
+are discontinued and not maintained. The user who is interested in a specific release can always
+checkout the rigth code tree by searching the latest commit under a given git tag carrying the
+release version. \ No newline at end of file