X-Git-Url: https://gerrit.akraino.org/r/gitweb?a=blobdiff_plain;f=README.md;h=0a0199bf806410c597705ce472383f55d5de64d5;hb=refs%2Fchanges%2F07%2F4807%2F1;hp=523b49d54e7a53aa2b7dc7f7765ac3e946ae699c;hpb=faf6493f117e1745a6875ecc67f2002d25db8ef7;p=icn.git

diff --git a/README.md b/README.md
index 523b49d..0a0199b 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,45 @@
-# Integrated Cloud Native
+> NOTE: The ICN project is presently in the incubation/pre-production
+> phase and is suitable for testing purposes only.
 
-Work in progress
+# Introduction
 
-For more information refer - https://wiki.akraino.org/pages/viewpage.action?pageId=11995140
+ICN addresses the infrastructure orchestration needed to bring up a
+site using baremetal servers. It strives to automate the process of
+installing a jump server (Local Controller) to the greatest degree
+possible – "zero touch installation". Once the jump server is booted
+and the compute cluster-specific values are provided, the controller
+begins to inspect and provision the baremetal servers until the
+cluster is entirely configured.
 
-## Build ISO
+# Table of Contents
+1. [Quick start](doc/quick-start.md)
+2. [Installation guide](doc/installation-guide.md)
+3. [Troubleshooting](doc/troubleshooting.md)
+4. [Software BOM](doc/software-bom.md)
 
-We should run the following commands on a fresh ubuntu 18.04 of kernel version 4.15.0-45-generic
+# Reporting a bug
 
-```bash
-cd ~
-mkdir -p workspace && cd workspace
-git clone "https://gerrit.akraino.org/r/icn" # may need to switch the branch based on your case
-sudo icn/tools/setup_build_machine.sh
-sudo icn/tools/collect.sh
-sudo icn/tools/create_usb_bootable.sh
-```
-
-The script builds an ISO based on the official ubuntu-18.04-server.iso. The generated ISO
-is located at `workspace/icn-ubuntu-18.04.iso`.
-All files under `icn` directory are copied into the ISO. During the installation of the ISO,
-these files are copied to infra-local-controller under `/opt/icn`.
+Please report any issues found in the [ICN
+JIRA](https://jira.akraino.org/projects/ICN/issues).  A Linux
+Foundation ID must be created first.
 
-## How to use the ISO to bootstrap a infra-local-controller
+# License
+Apache license v2.0
 
-1. We burn the ISO onto an USB strick.
-2. We plug this USB into a server and press the power-on button. (choose boot from the USB strick)
-3. The ubuntu 18.04 is supposed to be installed on the server, then it reboots automatically.
-4. Now we can login the server with the default user/password of icn/icn
-5. We can do anything we need here to install/configure/launch services.
+```
+/*
+* Copyright 2019-2022 Intel Corporation, Inc
+*
+* 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.
+*/
+```