aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNeels Hofmeyr <nhofmeyr@sysmocom.de>2016-11-11 22:16:12 +0100
committerNeels Hofmeyr <nhofmeyr@sysmocom.de>2016-11-23 00:05:13 +0100
commitbe671bc61f136a87c2705e11b0758e42ca72963d (patch)
treedf2758f8069042ad3b0270e26a187fd0e9b7d0da
parentf7b559f96017f994fc5a3a7b3e73d09f5a195bcb (diff)
cosmetic: tweak README
I noticed that the README is prominently shown on github, so it makes sense to get rid of the worst typos and misinformation there. Change-Id: I60defef6224a78bb84d7d0b57bc8da17ad7877bb
-rw-r--r--README41
1 files changed, 21 insertions, 20 deletions
diff --git a/README b/README
index 967b0808..1fe6e8c8 100644
--- a/README
+++ b/README
@@ -1,26 +1,29 @@
-Repository forw the Osmocom BTS implementation.
+= Repository for the Osmocom BTS implementation. =
-This code implementes the Layer 2 and higher of a more or less
-conventional GSM BTS (Base Transceiver Station) - however, using an
-Abis/IP interface, rather than the old-fashioned E1/T1.
+For most complete and accurate information, please refer to
+https://osmocom.org/projects/osmobts/wiki
-Specifically, this includes
- * BTS-Side implementation of TS 08.58 (RSL) and TS 12.21 (OML)
- * BTS-Side implementation of LAPDm (using libosmocore/libosmogsm)
- * A somewhat separated interface between those higher layer parts
- and the Layer1 interface.
+To submit patches, please refer to
+https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit
+(Note: github pull requests are rejected by a bot)
+
+== Summary ==
-Right now, only one hardware and Layer1 are supported: The sysmocom
-sysmoBTS.
+This code implements Layer 2 and higher of a more or less conventional GSM BTS
+(Base Transceiver Station) - however, using an Abis/IP interface, rather than
+the old-fashioned E1/T1.
-There is some experimental and way incomplete code to use a couple of
-OsmocomBB phones and run them in the BTS. However, the required code
-for the Calypso DSP code have not been written yet. This would still
-require a lot of work.
+Specifically, this includes
+ * BTS-side implementation of TS 08.58 (RSL) and TS 12.21 (OML)
+ * BTS-side implementation of LAPDm (using libosmocore/libosmogsm)
+ * A somewhat separated interface between those higher layer parts and the
+ Layer1 interface.
-Some additional work is being done in using some parts of the OpenBTS
-L1FEC and glue it against omso-bts. This code is called osmo-trx and
-requires the jolly/trx branch of this repository.
+Several kinds of BTS hardware are supported:
+ * sysmocom sysmoBTS
+ * Octasic octphy
+ * Nutaq litecell 1.5
+ * software-defined radio based osmo-bts-trx (e.g. B210)
== Known Limitations ==
@@ -52,5 +55,3 @@ implementation:
* Doesn't yet include MAC address in Abis/IP Identity message
* MphConfig.CNF can be returned to the wrong callback. E.g. with Tx Power
and ciphering. The dispatch should take a look at the hLayer3.
-
-