laforge has uploaded this change for review. ( 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(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-bsc refs/changes/46/28346/1
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..659d07b
--- /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-bts 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: 1
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-MessageType: newchange
laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-sccp/+/28335 )
Change subject: update git URLs (git -> https; gitea)
......................................................................
update git URLs (git -> https; gitea)
Change-Id: Idac4924a077b5389e85efaf62081589fc3de06ad
---
M README.md
M configure.ac
M contrib/test/test-m3ua.sh
M contrib/test/test-sua.sh
M debian/control
5 files changed, 7 insertions(+), 8 deletions(-)
Approvals:
Jenkins Builder: Verified
laforge: Looks good to me, approved
diff --git a/README.md b/README.md
index 98b3591..2ec30c8 100644
--- a/README.md
+++ b/README.md
@@ -20,10 +20,9 @@
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
+ git clone https://gitea.osmocom.org/osmocom/libosmo-sccp
-There is a cgit interface at https://git.osmocom.org/libosmo-sccp/
+There is a web interface at <https://gitea.osmocom.org/osmocom/libosmo-sccp>
Documentation
-------------
diff --git a/configure.ac b/configure.ac
index 4367b8a..92325d7 100644
--- a/configure.ac
+++ b/configure.ac
@@ -170,7 +170,7 @@
AM_PATH_PYTHON
AC_CHECK_PROG(OSMOTESTEXT_CHECK,osmo_verify_transcript_vty.py,yes)
if test "x$OSMOTESTEXT_CHECK" != "xyes" ; then
- AC_MSG_ERROR([Please install git://osmocom.org/python/osmo-python-tests to run the VTY/CTRL tests.])
+ AC_MSG_ERROR([Please install https://gitea.osmocom.org/cellular-infrastructure/osmo-python-tests to run the VTY/CTRL tests.])
fi
fi
AC_MSG_CHECKING([whether to enable VTY/CTRL tests])
diff --git a/contrib/test/test-m3ua.sh b/contrib/test/test-m3ua.sh
index 0f81fe8..927f514 100755
--- a/contrib/test/test-m3ua.sh
+++ b/contrib/test/test-m3ua.sh
@@ -3,7 +3,7 @@
# this script executes m3ua-testtool against osmo-stp. It assumes that
# it is called from within libosmo-sccp/contrib/test and also assumes
# that adjacent to the libosmo-sccp, there's a check-out of
-# git://git.osmocom.org/nplab/m3ua-testtool
+# https://gitea.osmocom.org/nplab/m3ua-testtool
# the top of the libosmo-sccp git repository
TOPDIR=../../
diff --git a/contrib/test/test-sua.sh b/contrib/test/test-sua.sh
index 0cb4e35..9f97f43 100755
--- a/contrib/test/test-sua.sh
+++ b/contrib/test/test-sua.sh
@@ -3,7 +3,7 @@
# this script executes m3ua-testtool against osmo-stp. It assumes that
# it is called from within libosmo-sccp/contrib/test and also assumes
# that adjacent to the libosmo-sccp, there's a check-out of
-# git://git.osmocom.org/nplab/m3ua-testtool
+# https://gitea.osmocom.org/nplab/sua-testtool
# the top of the libosmo-sccp git repository
TOPDIR=../../
diff --git a/debian/control b/debian/control
index 7955055..5885de9 100644
--- a/debian/control
+++ b/debian/control
@@ -17,8 +17,8 @@
libsctp-dev,
osmo-gsm-manuals-dev (>= 1.1.0)
Standards-Version: 3.9.7
-Vcs-Git: git://git.osmocom.org/libosmo-sccp.git
-Vcs-Browser: http://git.osmocom.org/libosmo-sccp/
+Vcs-Git: https://gitea.osmocom.org/osmocom/libosmo-sccp
+Vcs-Browser: https://gitea.osmocom.org/osmocom/libosmo-sccp
Homepage: https://projects.osmocom.org/projects/libosmo-sccp
Package: libosmo-sccp-dev
--
To view, visit https://gerrit.osmocom.org/c/libosmo-sccp/+/28335
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: libosmo-sccp
Gerrit-Branch: master
Gerrit-Change-Id: Idac4924a077b5389e85efaf62081589fc3de06ad
Gerrit-Change-Number: 28335
Gerrit-PatchSet: 1
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-MessageType: merged