diff --git a/README b/README deleted file mode 100644 index a14ba380..00000000 --- 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 00000000..34687363 --- /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 + and +, respectively. + +Documentation +------------- + +You can find the user manual at + +and the VTY reference manual at +. diff --git a/contrib/osmo-gbproxy.spec.in b/contrib/osmo-gbproxy.spec.in index 4bb071c1..9392147a 100644 --- a/contrib/osmo-gbproxy.spec.in +++ b/contrib/osmo-gbproxy.spec.in @@ -68,7 +68,7 @@ make %{?_smp_mflags} 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 4f4fdfb7..66e36b97 100644 --- a/debian/copyright +++ b/debian/copyright @@ -7,7 +7,7 @@ Files: .gitignore .mailmap AUTHORS Makefile.am - README + README.md README.vty-tests configure.ac contrib/Makefile.am