aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-03-16 15:45:16 +0100
committerHarald Welte <laforge@gnumonks.org>2017-03-16 15:45:29 +0100
commit70a82f0c21635e541d03bd1715eaffd4ce5e78fe (patch)
tree44616f92cb8788592ef962d32c8c03a826f9a49b
parent5fd93e02f818aecfc73db66e8064858442122959 (diff)
Add README file to libosmo-netif repository
-rw-r--r--Makefile.am2
-rw-r--r--README.md54
2 files changed, 55 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am
index 7b43d4d..a78c523 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -6,7 +6,7 @@ SUBDIRS = include src examples tests
pkgconfigdir = $(libdir)/pkgconfig
pkgconfig_DATA = libosmo-netif.pc
-EXTRA_DIST = .version
+EXTRA_DIST = .version README.md
BUILT_SOURCES = $(top_srcdir)/.version
$(top_srcdir)/.version:
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6583792
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+libosmo-netif- Osmocom network interface interface library
+==========================================================
+
+This repository contains a C-language library that form the
+basis of various higher-layer cellular communications protocol
+implementation. It implements stream server and clients for TCP, UDP,
+IPA as well as the non-standard/proprietary OSMUX protocol.
+
+Homepage
+--------
+
+The official homepage of the project is
+https://osmocom.org/projects/libosmo-netif
+
+GIT Repository
+--------------
+
+You can clone from the official libosmo-netif.git repository using
+
+ git clone git://git.osmocom.org/libosmo-netif.git
+
+There is a cgit interface at http://git.osmocom.org/libosmo-netif/
+
+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-netif 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-netif can be seen at
+https://gerrit.osmocom.org/#/q/project:libosmo-netif+status:open