diff options
authorHarald Welte <laforge@gnumonks.org>2017-03-16 15:36:19 +0100
committerHarald Welte <laforge@gnumonks.org>2017-03-16 15:36:35 +0100
commit7861ebac8493ee4ef9f3ccf8ea22918e1caab053 (patch)
parent027e11936385a38bd331ea29f4f47a7b443c0932 (diff)
Add README file to libosmo-abis repository
2 files changed, 67 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am
index 7901d3b..9e24bef 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -12,4 +12,4 @@ $(top_srcdir)/.version:
echo $(VERSION) > $(distdir)/.tarball-version
-EXTRA_DIST = .version
+EXTRA_DIST = .version README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5278563
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+libosmo-abis - Osmocom Abis interface library
+This repository contains a set of C-language libraries that form the
+A-bis interface library of [Osmocom](https://osmocom.org/) Open Source
+Mobile Communications projects such as OpenBSC / OsmoBSC.
+Historically, a lot of this code was developed as part of the
+[OpenBSC](https://osmocom.org/projects/openbsc) project, but which are
+of a more generic nature and thus useful to (at least) other programs
+that we develop in the sphere of Free Software / Open Source mobile
+The libosmo-abis.git repository build multiple libraries:
+* **libosmoabis** contains some abstraction layer over E1/T1 and IP
+ based ETSI/3GPP A-bis interface. It can use mISDN and DAHDI as
+ underlying driver/hardware.
+* **libosmotrau** contains routines related to A-bis TRAU frame handling
+The official homepage of the project is
+GIT Repository
+You can clone from the official libosmo-abis.git repository using
+ git clone git://git.osmocom.org/libosmo-abis.git
+There is a cgit interface at http://git.osmocom.org/libosmo-abis/
+There is no Doxygen-generated API documentation yet for this library. It
+would be great to some day have it, comparable to libosmocore.
+Mailing List
+Discussions related to libosmo-abis 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 libosmo-abis can be seen at