aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Welte <laforge@osmocom.org>2021-03-21 22:50:59 +0100
committerHarald Welte <laforge@osmocom.org>2021-03-21 22:51:55 +0100
commit4fea7a7083047a2f553a126ce983a7ce07ce4750 (patch)
tree88961b72b600d2f953c5a78b3adf42a9ba599991
parent807364dcae1eb33097e637a90c5de39e6c54509b (diff)
add README.md describing what this repository is about
-rw-r--r--README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1ff6bc9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+osmo-e1d - Osmocom E1 interface daemon
+======================================
+
+This repository contains the osmocom E1 interface daemon,
+a pure userspace driver for the icE1usb hardware USB E1 adapter.
+
+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-e1d/wiki
+
+GIT Repository
+--------------
+
+You can clone from the official osmo-e1d.git repository using
+
+ git clone git://git.osmocom.org/osmo-e1d.git
+ git clone https://git.osmocom.org/osmo-e1d.git
+
+There is a cgit interface at https://git.osmocom.org/osmo-e1d/
+
+Related Links
+-------------
+
+* [icE1usb USB E1 adapter](https://osmocom.org/projects/e1-t1-adapter/wiki/IcE1usb)
+* [alternative DAHDI driver](https://osmocom.org/issues/4923)
+
+Mailing List
+------------
+
+Discussions related to osmo-e1d 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-e1d can be seen at
+https://gerrit.osmocom.org/#/q/project:osmo-e1d+status:open