Update syntax of README.md to be markdown 27/106927/5
authorŠimon Ukuš <simon.ukus@pantheon.tech>
Tue, 18 Jul 2023 11:08:07 +0000 (13:08 +0200)
committerŠimon Ukuš <simon.ukus@pantheon.tech>
Tue, 18 Jul 2023 11:08:42 +0000 (13:08 +0200)
The original syntax is reStructuredText, but we need markdown syntax,
since markdown is the standard for README files.

JIRA: BGPCEP-1025
Change-Id: Ia8901c1be7ec51a718eeab01421f66975bb602c1
Signed-off-by: Šimon Ukuš <simon.ukus@pantheon.tech>
README.md

index 645d4d3bbada67d2ea930bdccd920cffc8b94113..bfaa643b2ace5141baac30ce1aec719e1c4c3de0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,44 +4,41 @@ This program and the accompanying materials are made available under the
 terms of the Eclipse Public License v1.0 which accompanies this distribution,
 and is available at http://www.eclipse.org/legal/epl-v10.html
 
-DIRECTORY ORGANIZATION
-======================
+## DIRECTORY ORGANIZATION
 
-src/site:
-    maven site plugin templates
+src/site:
+    maven site plugin templates
 
-mockito-configuration:
-    default configuration of mockito framework
+mockito-configuration:
+    default configuration of mockito framework
 
-concepts:
-    Common networking concepts, shared between the protocols
+concepts:
+    Common networking concepts, shared between the protocols
 
-util:
-    Common utility classes
+util:
+    Common utility classes
 
-bgp:
-    BGP-related artifacts
+bgp:
+    BGP-related artifacts
 
-pcep:
-    PCEP-related artifacts
+pcep:
+    PCEP-related artifacts
 
-pcep/pcepy:
-    Python PCEP library
+pcep/pcepy:
+    Python PCEP library
 
-pcep/pcepdump:
-    Python-based PCEP listener and debug tool
+pcep/pcepdump:
+    Python-based PCEP listener and debug tool
 
-rsvp:
-    RSVP modeling concepts (needed by pcep)
+rsvp:
+    RSVP modeling concepts (needed by pcep)
 
+## HOW TO BUILD
 
-HOW TO BUILD
-============
 In order to build it's required to have JDK 1.7+ and Maven 3+, to get
 a build going it's needed to:
 
-1) Go in the root directory and run
-   "mvn clean install"
+1. Go in the root directory and run
+   `mvn clean install`
 
-2) After successful completion, look for org.opendaylight.bgpcep artifacts
-   in your local maven repository.
+2. After successful completion, look for org.opendaylight.bgpcep artifacts in your local maven repository.