path: root/README.md
diff options
authorHarald Welte <laforge@gnumonks.org>2017-03-17 18:15:20 +0100
committerHarald Welte <laforge@gnumonks.org>2017-03-17 18:15:20 +0100
commit2c45e9082afada5249a7347a35bd8812a88b5aa7 (patch)
tree5ce58c76d5a9f3dca5807e25f5f2a357650198a7 /README.md
parent6a840b49a52d36402f0779defc173dc69b5ad559 (diff)
Update README with project related information and convert to Markdown
Also, include it in 'make dist' tarballs. Change-Id: Ia28743b7ea3510097f841f83d2eca2669b4d73ea
Diffstat (limited to 'README.md')
1 files changed, 103 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..edbde9f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,103 @@
+osmo-iuh - Osmocom Iuh and HNB-GW implementation
+This repository contains a C-language implementation of the 3GPP Iuh
+interface, together with a HNB-GW (Home NodeB Gateway). You can use it
+to interface Iuh-speaking femtocells/small cells to Iu-speaking MSCs and
+It is part of the [Osmocom](https://osmocom.org/) Open Source Mobile
+Communications project.
+The official homepage of the project is
+GIT Repository
+You can clone from the official libosmocore.git repository using
+ git clone git://git.osmocom.org/osmo-iuh.git
+There is a cgit interface at http://git.osmocom.org/osmo-iuh/
+There is currently no documentation beyond the wiki available on the
+homepage. We would love to see somebody contributing a manual that can
+be part of the osmo-gsm-manuals suite.
+Mailing List
+Discussions related to osmo-iuh 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 osmo-iuh can be seen at
+It is generally best to check the wiki for the most up-to-date build
+As external library dependencies, you will need
+* libosmocore from git://git.osmocom.org/libosmocore
+* libasn1c from git://git.osmocom.org/libasn1c
+* libsctp-dev (this is the package name in Debian)
+* libosmo-netif from git://git.osmocom.org/libosmo-netif (sysmocom/sctp branch)
+* libosmo-sccp from git://git.osmocom.org/libosmo-sccp (sysmocom/iu branch)
+To bootstrap the build, in the root directory, run:
+ autoreconf --install
+After that, run the usual
+ ./configure [options]
+ make
+ [sudo] make install
+Note: osmo-iuh just left very active development (December 2015, January
+2016), so your mileage may vary.
+If you run the 'hnbgw' executable, it will open a listening SCTP socket
+and wait for incoming Iuh connections. It will accept any
+HNB-REGISTER-REQUEST, and it will establish Iu (over SUA) connections
+towards the MSC and SGSN.
+Regenerating C code from ASN.1 source
+In order to re-generate the C source code from the ASN.1 source,
+you will need a modified asn1c which has the following features:
+* APER support (the patch from Eurecom, or its forward-ported version
+ from the aper branch of git://git.osmocom.org/asn1c)
+* support for prefixing the generated types (aper-prefix branch of
+ git://git.osmocom.org/asn1c)