From 49eca8a1b7eebf8eb0f1baf3aa76edbebe277db3 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=C5=A0imon=20Uku=C5=A1?= Date: Tue, 18 Jul 2023 13:08:07 +0200 Subject: [PATCH] Update syntax of README.md to be markdown MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit 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š --- README.md | 49 +++++++++++++++++++++++-------------------------- 1 file changed, 23 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 645d4d3bba..bfaa643b2a 100644 --- 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. -- 2.36.6