add README.md on what this repository is all about

This commit is contained in:
Harald Welte 2021-03-21 23:29:34 +01:00
parent 39f06f3eef
commit 1efeba66f5
1 changed files with 43 additions and 0 deletions

43
README.md Normal file
View File

@ -0,0 +1,43 @@
osmo-dfds - RF delay simulator
==============================
This repository contains the source code for an RF delay simulator,
which can be used to artificially delay RF signals by a configurable
amount of [variable] delay. This is useful to test timing control
loops in TDMA systems, such as GSM.
It is part of the [Osmocom](https://osmocom.org/) Open Source Mobile
Communications project.
Homepage
--------
The official homepage of the project is
https://osmocom.org/projects/osmo-rfds/wiki/Wiki
GIT Repository
--------------
You can clone from the official osmo-rfds.git repository using
git clone git://git.osmocom.org/osmo-rfds.git
git clone https://git.osmocom.org/osmo-rfds.git
There is a cgit interface at https://git.osmocom.org/osmo-rfds/
Documentation
-------------
See the doc/ sub-directory.
Mailing List
------------
Discussions related to osmo-rfds 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.