path: root/README.md
diff options
authorPau Espin Pedrol <pespin@sysmocom.de>2019-07-29 15:43:57 +0200
committerlaforge <laforge@gnumonks.org>2019-08-01 15:17:30 +0000
commitc7ac63afa5e840be22e8cad0d2a9419a9c6c1e55 (patch)
treec8ebc6c320e07b4c7d425404591f48265143874c /README.md
parentcbc02086d58edec257c20645d147284fba004a5f (diff)
Drop old README information, provide new updated README
Previous content in README file is actually a description of the TRXD and TRXC protocols, and it has already been moved to the User Manual some time ago. INSTALLATION contained README related information, but it was really out of date. So this commit basically drops those two files and provides a new README.md with content taken from Osmocom's OsmoTRX project wiki page. Change-Id: I3df00799ce80aa4af43225e69a408ba2cbc444db
Diffstat (limited to 'README.md')
1 files changed, 66 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dc026e0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+About OsmTRX
+OsmoTRX is a software-defined radio transceiver that implements the Layer 1
+physical layer of a BTS comprising the following 3GPP specifications:
+* TS 05.01 "Physical layer on the radio path"
+* TS 05.02 "Multiplexing and Multiple Access on the Radio Path"
+* TS 05.04 "Modulation"
+* TS 05.10 "Radio subsystem synchronization"
+OsmoTRX is based on the transceiver code from the
+[OpenBTS](https://osmocom.org/projects/osmobts/wiki/OpenBTS) project, but setup
+to operate independently with the purpose of using with non-OpenBTS software and
+projects, while still maintaining backwards compatibility with OpenBTS when
+possible. Currently there are numerous features contained in OsmoTRX that extend
+the functionality of the OpenBTS transceiver. These features include enhanced
+support for various embedded platforms - notably ARM - and dual channel
+diversity support for the Fairwaves umtrx.
+The official homepage of the project is
+GIT Repository
+You can clone from the official osmo-trx.git repository using
+ git clone git://git.osmocom.org/osmo-trx.git
+There is a cgit interface at <http://git.osmocom.org/osmo-trx/>
+Doxygen-generated API documentation is generated during the build process, but
+also available online for each of the sub-libraries at User Manual for OsmoTRX
+can be generated during the build process, and is also available online at
+Mailing List
+Discussions related to OsmoTRX 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
+when posting.
+Our coding standards are described at
+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 OsmoTRX can be seen at