summaryrefslogtreecommitdiffstats
path: root/docs/source/started.md
diff options
context:
space:
mode:
authorLuca Muscariello <muscariello@ieee.org>2020-02-13 21:31:20 +0100
committerMauro Sardara <msardara@cisco.com>2020-02-13 20:39:34 +0000
commit7ecd7bf20999042a13e88c2ac3c8b851d1db8da4 (patch)
tree848a7f3a2ba716af8fc97a6d00e23e2cb2d2e5ca /docs/source/started.md
parent3bce9bfdce707313de4f9cccdc867abd9edf82df (diff)
[HICN-519] Documentation update
Change-Id: Iba61bc07196643b8061f0cb0f7213c7e0b256020 Signed-off-by: Luca Muscariello <muscariello@ieee.org>
Diffstat (limited to 'docs/source/started.md')
-rw-r--r--docs/source/started.md72
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/source/started.md b/docs/source/started.md
new file mode 100644
index 000000000..099b5f4d9
--- /dev/null
+++ b/docs/source/started.md
@@ -0,0 +1,72 @@
+# Getting started
+
+The Hybrid ICN software distribution can be installed for several platforms.
+The network stack comes in two different implementations: one scalable based
+on VPP and one portable based on IPC and sockets.
+
+The transport stack is a unique library that is used for both the scalable
+and portable network stacks.
+
+## Platforms
+
+- Ubuntu 18.04 LTS (amd64, arm64)
+- Debian Stable/Testing
+- Red Hat Enterprise Linux 7
+- CentOS 7
+- Android 10 (amd64, arm64)
+- iOS 13
+- macOS 10.15
+- Windows 10
+
+Other platforms and architectures may work.
+You can either use released packages, or compile hicn from sources.
+
+### Ubuntu 18.04/16.04 amd64/arm64
+
+```shell
+curl -s https://packagecloud.io/install/repositories/fdio/release/script.deb.sh | sudo bash
+```
+
+### CentOS 7 amd64
+
+```shell
+curl -s https://packagecloud.io/install/repositories/fdio/release/script.rpm.sh | sudo bash
+```
+
+### macOS
+
+```shell
+brew install hicn
+```
+
+### Android
+
+Install the applications via the Google Play Store
+<https://play.google.com/store/apps/developer?id=ICN+Team>
+
+### iOS
+
+Coming soon.
+
+### Windows 10
+
+Coming soon.
+
+## License
+
+This software is distributed under the following license:
+
+```shell
+Copyright (c) 2017-2020 Cisco and/or its affiliates.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at:
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```