From 7861ebac8493ee4ef9f3ccf8ea22918e1caab053 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Thu, 16 Mar 2017 15:36:19 +0100 Subject: Add README file to libosmo-abis repository Change-Id: I76ced414b22637792389fcf79ae6c7159502259b --- Makefile.am | 2 +- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 README.md 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: dist-hook: 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 +communications. + +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 + +Homepage +-------- + +The official homepage of the project is +https://osmocom.org/projects/libosmo-abis + +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/ + +Documentation +------------- + +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 +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 libosmo-abis can be seen at +https://gerrit.osmocom.org/#/q/project:libosmo-abis+status:open -- cgit v1.2.3