diff options
| -rw-r--r-- | Makefile.am | 3 | ||||
| -rw-r--r-- | README.md (renamed from README) | 80 |
2 files changed, 69 insertions, 14 deletions
diff --git a/Makefile.am b/Makefile.am index 0c252ac2..9a5e26f0 100644 --- a/Makefile.am +++ b/Makefile.am @@ -12,4 +12,5 @@ EXTRA_DIST = \ contrib/sysmobts-calib/sysmobts-layer1.c \ contrib/sysmobts-calib/sysmobts-layer1.h \ doc/examples/sysmo/osmo-bts.cfg \ - doc/examples/sysmobts-mgr.cfg + doc/examples/sysmobts-mgr.cfg \ + README.md @@ -1,13 +1,10 @@ -= Repository for the Osmocom BTS implementation. = +osmo-bts - Osmocom BTS Implementation +==================================== -For most complete and accurate information, please refer to -https://osmocom.org/projects/osmobts/wiki - -To submit patches, please refer to -https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit -(Note: github pull requests are rejected by a bot) - -== Summary == +This repository contains a C-language implementation of a GSM Base +Transceiver Station (BTS). It is part of the +[Osmocom](https://osmocom.org/) Open Source Mobile Communications +project. 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 @@ -23,14 +20,69 @@ 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) + * software-defined radio based osmo-bts-trx (e.g. USRP B210, UmTRX) + +Homepage +-------- + +The official homepage of the project is +https://osmocom.org/projects/osmobts/wiki + +GIT Repository +-------------- + +You can clone from the official osmo-bts.git repository using + + git clone git://git.osmocom.org/osmo-bts.git + +There is a cgit interface at http://git.osmocom.org/osmo-bts/ + +Documentation +------------- -== Known Limitations == +We provide a +[User Manual](http://ftp.osmocom.org/docs/latest/osmobts-usermanual.pdf) +as well as a +[VTY Reference Manual](http://ftp.osmocom.org/docs/latest/osmobsc-vty-reference.pdf) +and a +[Abis refrence MAnual](http://ftp.osmocom.org/docs/latest/osmobts-abis.pdf) +describing the OsmoBTS specific A-bis dialect. + +Mailing List +------------ + +Discussions related to osmo-bts are happening on the +openbsc@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-bts can be seen at +https://gerrit.osmocom.org/#/q/project:osmo-bts+status:open + +Known Limitations +================= As of August 20, 2015, the following known limitations exist in this implementation: -=== Common Core === +Common Core +----------- + * No Extended BCCH support * System Information limited to 1,2,2bis,2ter,2quater,3,4,5,6,9,13 * No RATSCCH in AMR @@ -45,7 +97,9 @@ implementation: * No support of TS 08.58 Supported Codec Types * No support of Bter frame / ENHANCED MEASUREMENT REPORT -=== osmo-bts-sysmo === +osmo-bts-sysmo +-------------- + * No CSD / ECSD support (not planned) * GSM-R frequency band supported, but no NCH/ASCI/SoLSA * All timeslots on one TRX have to use same training sequence (TSC) |