Change in osmo-gbproxy[master]: Update README to cover osmo-gbproxy and not osmo-sgsn

[osmith]

osmith has submitted this change. ( https://gerrit.osmocom.org/c/osmo-gbproxy/+/22581 )

Change subject: Update README to cover osmo-gbproxy and not osmo-sgsn
......................................................................

Update README to cover osmo-gbproxy and not osmo-sgsn

While we're at it, also convert it to markdown.

Related: OS#4992
Change-Id: Ic7e86dfed985f98ae87af9adcde6f776c5a15044
---
D README
A README.md
M contrib/osmo-gbproxy.spec.in
M debian/copyright
4 files changed, 30 insertions(+), 19 deletions(-)

Approvals:
  Jenkins Builder: Verified
  laforge: Looks good to me, approved



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..3468736
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+About osmo-gbproxy
+==================
+
+osmo-gbproxy is a proxy for the Gb interface within the 3GPP GERAN (GPRS/EDGE RAN)
+architecture. It is part of the [Osmocom](https://osmocom.org/) Open Source
+Mobile Communications projects.
+
+It allows you to aggregate many Gb links/connections into one. It also
+has the ability to convert between different Gb interface protocol
+stacking, such as from Gb-over-FrameRelay to Gb-over-IP.
+
+Until 2021 it used to be part of the osmo-sgsn git repository, and before that
+(until 2017) part of openbsc.git
+
+Homepage and Issue Tracker
+--------------------------
+
+Find the issue tracker and wiki online at
+<https://osmocom.org/projects/osmo-gbproxy> and
+<https://osmocom.org/projects/osmo-gbproxy/wiki>, respectively.
+
+Documentation
+-------------
+
+You can find the user manual at
+<https://ftp.osmocom.org/docs/latest/osmogbproxy-usermanual.pdf>
+and the VTY reference manual at
+<https://ftp.osmocom.org/docs/latest/osmogbproxy-vty-reference.pdf>.
diff --git a/contrib/osmo-gbproxy.spec.in b/contrib/osmo-gbproxy.spec.in
index 4bb071c..9392147 100644
--- a/contrib/osmo-gbproxy.spec.in
+++ b/contrib/osmo-gbproxy.spec.in
@@ -68,7 +68,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
 %{_docdir}/%{name}/examples/osmo-sgsn/osmo-gbproxy.cfg
diff --git a/debian/copyright b/debian/copyright
index 4f4fdfb..66e36b9 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -7,7 +7,7 @@
            .mailmap
            AUTHORS
            Makefile.am
-           README
+           README.md
            README.vty-tests
            configure.ac
            contrib/Makefile.am

-- 
To view, visit https://gerrit.osmocom.org/c/osmo-gbproxy/+/22581
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-gbproxy
Gerrit-Branch: master
Gerrit-Change-Id: Ic7e86dfed985f98ae87af9adcde6f776c5a15044
Gerrit-Change-Number: 22581
Gerrit-PatchSet: 5
Gerrit-Owner: laforge <laforge at osmocom.org>
Gerrit-Assignee: osmith <osmith at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: laforge <laforge at osmocom.org>
Gerrit-Reviewer: osmith <osmith at sysmocom.de>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20210201/471d300b/attachment.htm>