[MERGED] osmo-bts[master]: README: Add general project information and convert to markdown

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.

Harald Welte gerrit-no-reply at lists.osmocom.org
Fri Mar 17 17:03:54 UTC 2017


Harald Welte has submitted this change and it was merged.

Change subject: README: Add general project information and convert to markdown
......................................................................


README: Add general project information and convert to markdown

Also, make sure README.md is included in EXTRA_DIST

Change-Id: Icd9192833e1f95758c84cad85f0f0289ff4eb32a
---
M Makefile.am
D README
A README.md
3 files changed, 113 insertions(+), 58 deletions(-)

Approvals:
  Harald Welte: Looks good to me, approved
  Jenkins Builder: Verified



diff --git a/Makefile.am b/Makefile.am
index 0c252ac..9a5e26f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -12,4 +12,5 @@
 	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
diff --git a/README b/README
deleted file mode 100644
index 1fe6e8c..0000000
--- a/README
+++ /dev/null
@@ -1,57 +0,0 @@
-= Repository for the 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 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.
-
-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.
-
-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 ==
-
-As of August 20, 2015, the following known limitations exist in this
-implementation:
-
-=== 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
- * No OML (TS 12.21) alarms yet (temperature, ...)
- * Only single-TRX BTS at this point
- * Will reject TS 12.21 STARTING TIME in SET BTS ATTR / SET CHAN ATTR
- * No support for frequency hopping
- * No reporting of interference levels as part of TS 08.58 RF RES IND
- * No error reporting in case PAGING COMMAND fails due to queue overflow
- * No use of TS 08.58 BS Power and MS Power parameters
- * No support of TS 08.58 MultiRate Control
- * No support of TS 08.58 Supported Codec Types
- * No support of Bter frame / ENHANCED MEASUREMENT REPORT
-
-=== 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)
- * No multi-TRX support yet, though hardware+L1 support stacking
- * Makes no use of 12.21 Intave Parameters and Interference
-   Level Boundaries
- * 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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a5bf9fd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,111 @@
+osmo-bts - Osmocom BTS Implementation
+====================================
+
+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
+the old-fashioned E1/T1.
+
+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.
+
+Several kinds of BTS hardware are supported:
+ * sysmocom sysmoBTS
+ * Octasic octphy
+ * Nutaq litecell 1.5
+ * 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
+-------------
+
+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 at 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
+-----------
+
+ * No Extended BCCH support
+ * System Information limited to 1,2,2bis,2ter,2quater,3,4,5,6,9,13
+ * No RATSCCH in AMR
+ * No OML (TS 12.21) alarms yet (temperature, ...)
+ * Only single-TRX BTS at this point
+ * Will reject TS 12.21 STARTING TIME in SET BTS ATTR / SET CHAN ATTR
+ * No support for frequency hopping
+ * No reporting of interference levels as part of TS 08.58 RF RES IND
+ * No error reporting in case PAGING COMMAND fails due to queue overflow
+ * No use of TS 08.58 BS Power and MS Power parameters
+ * No support of TS 08.58 MultiRate Control
+ * No support of TS 08.58 Supported Codec Types
+ * No support of Bter frame / ENHANCED MEASUREMENT REPORT
+
+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)
+ * No multi-TRX support yet, though hardware+L1 support stacking
+ * Makes no use of 12.21 Intave Parameters and Interference
+   Level Boundaries
+ * 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.

-- 
To view, visit https://gerrit.osmocom.org/2115
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: Icd9192833e1f95758c84cad85f0f0289ff4eb32a
Gerrit-PatchSet: 1
Gerrit-Project: osmo-bts
Gerrit-Branch: master
Gerrit-Owner: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder



More information about the gerrit-log mailing list