aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Welte <laforge@osmocom.org>2021-03-21 22:56:42 +0100
committerHarald Welte <laforge@osmocom.org>2021-03-21 22:56:42 +0100
commite5ffedf526133b75b2d779110ffcb8578b029d6c (patch)
treeb36673e717665672a6608a25b336ebb0246e5782
parent63043933636aa3b8c4416124034c20bb7b3a7d68 (diff)
Add README.md describing what this repo is aboutHEADmaster
-rw-r--r--README.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..98b3591
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+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.
+
+Homepage
+--------
+
+The official homepage of libosmo-sccp is
+ https://osmocom.org/projects/libosmo-sccp/wiki
+
+The official homepage of osmo-stp is
+ https://osmocom.org/projects/osmo-stp/wiki
+
+GIT Repository
+--------------
+
+You can clone from the official git repository using
+
+ git clone git://git.osmocom.org/libosmo-sccp.git
+ git clone https://git.osmocom.org/libosmo-sccp.git
+
+There is a cgit interface at https://git.osmocom.org/libosmo-sccp/
+
+Documentation
+-------------
+
+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
+[User Manual](https://ftp.osmocom.org/docs/latest/osmostp-usermanual.pdf)
+as well as the VTY reference manuals
+* [VTY Reference Manual for osmo-stp](https://ftp.osmocom.org/docs/latest/osmostp-vty-reference.pdf)
+
+Mailing List
+------------
+
+Discussions related to osmo-stp are happening on the
+openbsc@lists.osmocom.org mailing list, please see
+https://lists.osmocom.org/mailman/listinfo/openbsc for subscription
+options and the list archive.
+
+Please observe the [Osmocom Mailing List
+Rules](https://osmocom.org/projects/cellular-infrastructure/wiki/Mailing_List_Rules)
+when posting.
+
+Contributing
+------------
+
+Our coding standards are described at
+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
+
+The current patch queue can be seen at
+https://gerrit.osmocom.org/#/q/project:libosmo-sccp+status:open