Rework README to markdown

.rst files are not parsed by GitHub thus for correct display
of our README we should translate it into .md format.

JIRA: NETCONF-1035
Change-Id: I0416dbd4ca22bd66a490a486c48f223cfe499a91
Signed-off-by: OleksandrZharov <Oleksandr.Zharov@pantheon.tech>

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..ea85ecd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# OpenDaylight NETCONF/RESTCONF implementation
+
+This project hosts implementations of protocols defined by the [IETF NETCONF Working Group](https://datatracker.ietf.org/wg/netconf/about/).
+In particular it implements: 
+* [Network Configuration Protocol (NETCONF)](https://www.rfc-editor.org/rfc/rfc6241) 
+* [RESTCONF Protocol](https://www.rfc-editor.org/rfc/rfc8040)
+
+Your immediate interests may be: 
+* Documentation is in [docs](https://docs.opendaylight.org/projects/netconf/en/latest/index.html)
+* Ready-to-applications are in [apps](apps/README.rst)
+
+Other that that, you may delve into gory details: 
+* basic project infrastructure, including [the BOM](artifacts/README.rst>), [Karaf features](features/README.rst),
+[Dynamic Karaf distribution](karaf/README.rst), [Static Karaf distribution](karaf-static/README.rst) and the [Common Maven Parent](parent/README.rst) 
+* [YANG models](models/README.rst) relating to this project 
+* [Transport layer](transport/README.rst) implementation 
+* [Low-level](protocol/README.rst) protocol implementations 
+* [High-level](plugins/README.rst) protocol integrations 
+* [NETCONF Key store](keystore/README.rst) implementation 
+* [NETCONF Trust store](truststore/READ.rst) implementation 
+* [applications](apps/README.md) for both end users and integrators

diff --git a/README.rst b/README.rst
deleted file mode 100644 (file)
index 1054851..0000000
--- a/README.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-============================================
-OpenDaylight NETCONF/RESTCONF implementation
-============================================
-
-This project hosts implementations of protocols defined by the
-`IETF NETCONF Working Group <https://datatracker.ietf.org/wg/netconf/about/>`__
-In particular it implements:
-* `Network Configuration Protocol (NETCONF) <https://www.rfc-editor.org/rfc/rfc6241>`__
-* `RESTCONF Protocol <https://www.rfc-editor.org/rfc/rfc8040>`__
-
-Your immediate interests may be:
-* Documentation is in :doc:`docs <https://docs.opendaylight.org/projects/netconf/en/latest/index.html>`
-* Ready-to-applications are in :doc:`apps <apps/README.rst>`
-
-Other that that, you may delve into gory details:
-* basic project infrastructure, including :doc:`the BOM <artifacts/README.rst>`,
-  :doc:`Karaf features <features/README.rst>`, :doc:`Dynamic Karaf distribution <karaf/README.rst>`,
-  :doc:`Static Karaf distribution <karaf-static/README.rst>` and the :doc:`Common Maven Parent <parent/README.rst>`
-* :doc:`YANG models <models/README.rst>` relating to this project
-* :doc:`Transport layer <transport/README.rst>` implementation
-* :doc:`Low-level <protocol/README.rst>` protocol implementations
-* :doc:`High-level <plugins/README.rst>` protocol integrations
-* :doc:`NETCONF Key store <keystore/README.rst>` implementation
-* :doc:`NETCONF Trust store <truststore/READ.rst>` implementation
-* :doc:`applications <appls/README.rst>` for both end users and integrators

diff --git a/apps/README.md b/apps/README.md
new file mode 100644 (file)
index 0000000..8605bfe
--- /dev/null
+++ b/apps/README.md
@@ -0,0 +1,10 @@
+# NETCONF applications
+
+This directory hosts the various applications built with NETCONF/RESTCONF [high-level](../plugins/README.rst) integrations.
+
+This includes:
+* [NETCONF Events on top of MD-SAL](netconf-events-mdsal/README.rst)
+* [CLI client](netconf-console/README.rst) for NETCONF servers
+* [NETCONF ietf-topology.yang](netconf-topology/README.rst) implementations
+  * for [single-node](netconf-topology-impl/README.rst) deployments
+  * for [clustenered](netconf-topology-singleton/README.rst) deployments

diff --git a/apps/README.rst b/apps/README.rst
deleted file mode 100644 (file)
index 23186e2..0000000
--- a/apps/README.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-====================
-NETCONF applications
-====================
-
-This directory hosts the various applications built with NETCONF/RESTCONF
-:doc:`high-level <../plugins/README.rst>` integrations.
-
-This includes:
-* :doc:`NETCONF Events on top of MD-SAL <netconf-events-mdsal/README.rst>`
-* :doc:`CLI client <netconf-console/README.rst>` for NETCONF servers
-* :doc:`NETCONF ietf-topology.yang <netconf-topology/README.rst>` implementations
-  * for :doc:`single-node <netconf-topology-impl/README.rst>` deployments
-  * for :doc:`clustenered <netconf-topology-singleton/README.rst>` deployments