pespin has submitted this change. ( https://gerrit.osmocom.org/c/osmo-bsc/+/28346 )
Change subject: convert README to README.md; expand on all fronts
......................................................................
convert README to README.md; expand on all fronts
This brings our README in line with the various other osmo-*
projects such as osmo-bts:
* use markdown formatting
* links to mailing list, documentation, git repo, ...
* reference the method of contribution + code review
Change-Id: I201bf47550a8fea500925205e0de1060d58d6136
---
D README
A README.md
M contrib/osmo-bsc.spec.in
3 files changed, 96 insertions(+), 27 deletions(-)
Approvals:
Jenkins Builder: Verified
pespin: Looks good to me, approved
diff --git a/README b/README
deleted file mode 100644
index e84849b..0000000
--- a/README
+++ /dev/null
@@ -1,26 +0,0 @@
-About OsmoBSC
-=============
-
-OsmoBSC originated from the OpenBSC project, which started as a minimalistic
-all-in-one implementation of the GSM Network. In 2017, OpenBSC had reached
-maturity and diversity (including M3UA SIGTRAN and 3G support in the form of
-IuCS and IuPS interfaces) that naturally lead to a separation of the all-in-one
-approach to fully independent separate programs as in typical GSM networks.
-
-OsmoBSC was one of the parts split off from the old openbsc.git. Before, it
-worked as a standalone osmo-bsc binary as well as a combination of libbsc and
-libmsc, i.e. the old OsmoNITB. Since the standalone OsmoMSC with a true A
-interface (and IuCS for 3G support) is available, OsmoBSC exists only as a
-separate standalone entity.
-
-OsmoBSC exposes
-- A over IP towards an MSC (e.g. OsmoMSC);
-- Abis interfaces towards various kinds of BTS;
-- The Osmocom typical telnet VTY and CTRL interfaces.
-
-Find OsmoBSC issue tracker and wiki online at
-https://osmocom.org/projects/osmobsc
-https://osmocom.org/projects/osmobsc/wiki
-
-OsmoBSC-NAT is a specialized solution to navigating RTP streams through a NAT.
-(Todo: describe in more detail)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5eed2f2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,95 @@
+osmo-bsc - Osmocom BSC Implementation
+=====================================
+
+This repository contains a C-language implementation of a GSM Base Station
+Controller (BSC). IT is part of the
+[Osmocom](https://osmocom.org/) Open Source Mobile Communications
+project.
+
+OsmoBSC exposes
+ * A over IP towards an MSC (e.g. OsmoMSC): 3GPP AoIP or SCCPlite
+ * Abis interfaces towards various kinds of BTS (osmo-bts, sysmobts, nanoBTS, Siemens, Nokia, Ericsson)
+ * The Osmocom typical telnet VTY and CTRL interfaces.
+ * The Osmocom typical statsd exporter.
+ * Cell Broadcast Service Protocol (CBSP) towards a CBC (Cell Broadcast Centre, such as osmo-cbc).
+ * Lb interface towards a SMLC (Serving Mobile Location Centre, such as osmo-smlc).
+
+
+Homepage
+--------
+
+You can find the OsmoBSC issue tracker and wiki online at
+<https://osmocom.org/projects/osmobsc> and <https://osmocom.org/projects/osmobsc/wiki>.
+
+
+GIT Repository
+--------------
+
+You can clone from the official osmo-bsc.git repository using
+
+ git clone https://gitea.osmocom.org/cellular-infrastructure/osmo-bsc
+
+There is a web interface at <https://gitea.osmocom.org/cellular-infrastructure/osmo-bsc>
+
+
+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/osmobsc-usermanual.pdf)
+as well as the [VTY Reference Manual](https://ftp.osmocom.org/docs/latest/osmobsc-vty-reference.pdf)
+
+There also is an
+[Abis reference Manual](https://ftp.osmocom.org/docs/latest/osmobts-abis.pdf)
+describing the OsmoBTS specific A-bis dialect, as well as a [CBSP Reference
+Maunal](https://downloads.osmocom.org/docs/latest/osmobsc-cbsp.pdf)
+describing the level of CBSP conformance.
+
+
+Mailing List
+------------
+
+Discussions related to osmo-bsc are happening on the
+openbsc(a)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 for osmo-bsc can be seen at
+<https://gerrit.osmocom.org/#/q/project:osmo-bsc+status:open>
+
+
+History
+-------
+
+OsmoBSC originated from the OpenBSC project, which started as a minimalistic
+all-in-one implementation of the GSM Network. In 2017, OpenBSC had reached
+maturity and diversity (including M3UA SIGTRAN and 3G support in the form of
+IuCS and IuPS interfaces) that naturally lead to a separation of the all-in-one
+approach to fully independent separate programs as in typical GSM networks.
+
+OsmoBSC was one of the parts split off from the old openbsc.git. Before, it
+worked as a standalone osmo-bsc binary as well as a combination of libbsc and
+libmsc, i.e. the old OsmoNITB. Since the standalone OsmoMSC with a true A
+interface (and IuCS for 3G support) is available, OsmoBSC exists only as a
+separate standalone entity.
+
+OsmoBSC-NAT is a specialized solution to navigating RTP streams through a NAT.
+(Todo: describe in more detail)
diff --git a/contrib/osmo-bsc.spec.in b/contrib/osmo-bsc.spec.in
index 00f9d8a..e46b61a 100644
--- a/contrib/osmo-bsc.spec.in
+++ b/contrib/osmo-bsc.spec.in
@@ -116,7 +116,7 @@
%files
%license COPYING
-%doc AUTHORS README
+%doc AUTHORS README.md
%{_bindir}/osmo-bsc
%dir %{_docdir}/%{name}/examples
%dir %{_docdir}/%{name}/examples/osmo-bsc
--
To view, visit https://gerrit.osmocom.org/c/osmo-bsc/+/28346
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-bsc
Gerrit-Branch: master
Gerrit-Change-Id: I201bf47550a8fea500925205e0de1060d58d6136
Gerrit-Change-Number: 28346
Gerrit-PatchSet: 2
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: merged
Attention is currently required from: laforge.
pespin has posted comments on this change. ( https://gerrit.osmocom.org/c/osmo-bsc/+/28346 )
Change subject: convert README to README.md; expand on all fronts
......................................................................
Patch Set 2: Code-Review+2
--
To view, visit https://gerrit.osmocom.org/c/osmo-bsc/+/28346
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-bsc
Gerrit-Branch: master
Gerrit-Change-Id: I201bf47550a8fea500925205e0de1060d58d6136
Gerrit-Change-Number: 28346
Gerrit-PatchSet: 2
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
Gerrit-Attention: laforge <laforge(a)osmocom.org>
Gerrit-Comment-Date: Mon, 20 Jun 2022 10:18:23 +0000
Gerrit-HasComments: No
Gerrit-Has-Labels: Yes
Gerrit-MessageType: comment
pespin has submitted this change. ( https://gerrit.osmocom.org/c/osmo-sgsn/+/28370 )
Change subject: README: Major update
......................................................................
README: Major update
* convert to markdown syntax
* bring in-line with other osmo-* README.md files, in terms of
links to git, mailing list, manuals, etc.
Change-Id: Ia4a4329c6ef6b8c833aa26832776dad662cdc7e9
---
D README
A README.md
M contrib/osmo-sgsn.spec.in
3 files changed, 82 insertions(+), 18 deletions(-)
Approvals:
pespin: Looks good to me, approved
Jenkins Builder: Verified
diff --git a/README b/README
deleted file mode 100644
index a14ba38..0000000
--- a/README
+++ /dev/null
@@ -1,17 +0,0 @@
-About OsmoSGSN
-==============
-
-OsmoSGSN originated from the OpenBSC project, as a separate program within
-openbsc.git. In 2017, OpenBSC was split in separate repositories, and hence
-OsmoSGSN was given its own separate git repository.
-
-OsmoSGSN exposes
-- GSUP towards OsmoHLR (or a MAP proxy);
-- GTP towards a GGSN (e.g. OsmoGGSN);
-- Gb towards a BSS (e.g. OsmoPCU);
-- IuPS towards an RNC or HNB-GW (e.g. OsmoHNBGW) for 3G data;
-- The Osmocom typical telnet VTY and CTRL interfaces.
-
-Find OsmoSGSN issue tracker and wiki online at
-https://osmocom.org/projects/osmosgsn
-https://osmocom.org/projects/osmosgsn/wiki
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..607b05d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,81 @@
+osmo-sgssn - Osmocom SGSN Implementation
+========================================
+
+This repository contains a C-language implementation of a GSM Serving GPRS
+Support Node (SGSN) for 2G (GSM) and 3G (UMTS). It is part of the
+[Osmocom](https://osmocom.org/) Open Source Mobile Communications
+project.
+
+OsmoSGSN exposes
+ * Gb towards PCUs (e.g. OsmoPCU): Various GbIP flavors + Gb/FR/E1
+ * GTP towards a GGSN (e.g. OsmoGGSN);
+ * IuPS over IP towards RNCs / HNBGW (e.g. osmo-hnbgw)
+ * The Osmocom typical telnet VTY and CTRL interfaces.
+ * The Osmocom typical statsd exporter.
+ * GSUP (custom MAP-like protocol) towards osmo-hlr
+
+OsmoSGSN implements
+ * GPRS mobility management
+ * GPRS session management
+
+Homepage
+--------
+
+You can find the OsmoSGSN issue tracker and wiki online at
+<https://osmocom.org/projects/osmosgsn> and <https://osmocom.org/projects/osmosgsn/wiki>.
+
+
+GIT Repository
+--------------
+
+You can clone from the official osmo-sgsn.git repository using
+
+ git clone https://gitea.osmocom.org/cellular-infrastructure/osmo-sgsn
+
+There is a web interface at <https://gitea.osmocom.org/cellular-infrastructure/osmo-sgsn>
+
+
+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/osmosgsn-usermanual.pdf)
+as well as the [VTY Reference Manual](https://ftp.osmocom.org/docs/latest/osmosgsn-vty-reference.pdf)
+
+
+Mailing List
+------------
+
+Discussions related to osmo-sgsn are happening on the
+osmocom-net-gprs(a)lists.osmocom.org mailing list, please see
+<https://lists.osmocom.org/postorius/lists/osmocom-net-gprs.lists.osmocom.or…> 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 for osmo-sgsn can be seen at
+<https://gerrit.osmocom.org/#/q/project:osmo-sgsn+status:open>
+
+
+History
+-------
+
+OsmoSGSN originated from the OpenBSC project, as a separate program within
+openbsc.git. In 2017, OpenBSC was split in separate repositories, and hence
+OsmoSGSN was given its own separate git repository.
diff --git a/contrib/osmo-sgsn.spec.in b/contrib/osmo-sgsn.spec.in
index 9cf18f6..daedf06 100644
--- a/contrib/osmo-sgsn.spec.in
+++ b/contrib/osmo-sgsn.spec.in
@@ -93,7 +93,7 @@
make %{?_smp_mflags} check || (find . -name testsuite.log -exec cat {} +)
%files
-%doc AUTHORS README
+%doc AUTHORS README.md
%dir %{_docdir}/%{name}/examples
%dir %{_docdir}/%{name}/examples/osmo-sgsn
%exclude %{_docdir}/%{name}/examples/osmo-gtphub
--
To view, visit https://gerrit.osmocom.org/c/osmo-sgsn/+/28370
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-sgsn
Gerrit-Branch: master
Gerrit-Change-Id: Ia4a4329c6ef6b8c833aa26832776dad662cdc7e9
Gerrit-Change-Number: 28370
Gerrit-PatchSet: 2
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: merged