laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-sccp/+/36421?usp=email )
Change subject: README.md: Update; improve markdown syntax ...................................................................... README.md: Update; improve markdown syntax Change-Id: Ifb24635f9debc873bb3416226c43984104be270c --- M README.md 1 file changed, 24 insertions(+), 16 deletions(-) Approvals: laforge: Looks good to me, approved Jenkins Builder: Verified diff --git a/README.md b/README.md index 2ec30c8..f1970d8 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,21 @@ libosmo-sccp - Osmocom SCCP, SIGTRAN and STP ============================================ -This repository contains a C-language library implementation of a -variety of telecom signaling protocols, such as M3UA, SUA, SCCP -(connection oriented and connectionless), as well as the OsmoSTP, a SS7 -Transfer Point. +This repository contains + +* *libosmo-sigtran*, a C-language library implementation of a variety of telecom signaling protocols, such as M3UA, SUA, SCCP + (connection oriented and connectionless) +* *OsmoSTP*, a SS7 Transfer Point that can be used to act as router and translator between M3UA, SUA and/or + SCCPlite +* *libosmo-sccp*, a legacy C-language [static] library that we used in prehistoric osmocom code before we had + libosmo-sigtran. Homepage -------- -The official homepage of libosmo-sccp is - https://osmocom.org/projects/libosmo-sccp/wiki +The official homepage of libosmo-sccp is at <https://osmocom.org/projects/libosmo-sccp/wiki> -The official homepage of osmo-stp is - https://osmocom.org/projects/osmo-stp/wiki +The official homepage of osmo-stp is at <https://osmocom.org/projects/osmo-stp/wiki> GIT Repository -------------- @@ -27,7 +29,7 @@ Documentation ------------- -User Manuals and VTY reference manuals are [optionally] built in PDF form +osmo-stp User Manuals and VTY reference manuals are [optionally] built in PDF form as part of the build process. Pre-rendered PDF version of the current "master" can be found at @@ -51,12 +53,9 @@ ------------ Our coding standards are described at -https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards +<https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards> -We us a gerrit based patch submission/review process for managing -contributions. Please see -https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit for -more details +We us a gerrit based patch submission/review process for managing contributions. Please see +<https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit> for more details -The current patch queue can be seen at -https://gerrit.osmocom.org/#/q/project:libosmo-sccp+status:open +The current patch queue can be seen at <https://gerrit.osmocom.org/#/q/project:libosmo-sccp+status:open> -- To view, visit https://gerrit.osmocom.org/c/libosmo-sccp/+/36421?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmo-sccp Gerrit-Branch: master Gerrit-Change-Id: Ifb24635f9debc873bb3416226c43984104be270c Gerrit-Change-Number: 36421 Gerrit-PatchSet: 1 Gerrit-Owner: laforge <[email protected]> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <[email protected]> Gerrit-MessageType: merged
