This is merely a historical archive of years 2008-2021, before the migration to mailman3.
A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.
Harald Welte gerrit-no-reply at lists.osmocom.orgHarald Welte has submitted this change and it was merged. Change subject: Update README with project related information and convert to Markdown ...................................................................... Update README with project related information and convert to Markdown Also, include it in 'make dist' tarballs. Change-Id: Ia28743b7ea3510097f841f83d2eca2669b4d73ea --- M Makefile.am D README A README.md 3 files changed, 104 insertions(+), 47 deletions(-) Approvals: Harald Welte: Looks good to me, approved Jenkins Builder: Verified diff --git a/Makefile.am b/Makefile.am index ab8191e..447b148 100644 --- a/Makefile.am +++ b/Makefile.am @@ -5,7 +5,7 @@ pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = libosmo-ranap.pc -EXTRA_DIST = asn1 .version +EXTRA_DIST = asn1 .version README.md BUILT_SOURCES = $(top_srcdir)/.version $(top_srcdir)/.version: diff --git a/README b/README deleted file mode 100644 index f24f676..0000000 --- a/README +++ /dev/null @@ -1,46 +0,0 @@ -Osmocom Iuh experimentation code -(C) 2015 by Harald Welte <laforge at gnumonks.org> - -This code is a playground for implementing something along the lines of -the an Iuh interface of a HNB-GW. The intent is to later integrate this -with OsmoNITB + OsmoSGSN, in order to have 3G capable 'network in the -box'. - -h1. Building - -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 - -h1. Using - -Note: osmo-iuh is in active development (December 2015, January 2016) so below -statements may outdate rapidly. - -there's not much to use yet. But 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, so the homeNodeB -should start to establish RUA and RANAP (which we haven't implemented -yet). - -h1. 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) 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 +SGSNs. + +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/osmohnbgw/wiki + +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/ + +Documentation +------------- + +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 at 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-iuh can be seen at +https://gerrit.osmocom.org/#/q/project:osmo-iuh+status:open + + +Building +-------- + +It is generally best to check the wiki for the most up-to-date build +instructions. + +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 + +Using +----- + +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) -- To view, visit https://gerrit.osmocom.org/2117 To unsubscribe, visit https://gerrit.osmocom.org/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ia28743b7ea3510097f841f83d2eca2669b4d73ea Gerrit-PatchSet: 1 Gerrit-Project: osmo-iuh Gerrit-Branch: master Gerrit-Owner: Harald Welte <laforge at gnumonks.org> Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org> Gerrit-Reviewer: Jenkins Builder