diff options
author | Harald Welte <laforge@osmocom.org> | 2021-03-21 22:46:07 +0100 |
---|---|---|
committer | Harald Welte <laforge@osmocom.org> | 2021-03-21 22:46:07 +0100 |
commit | ed2e36316b4a7d2f9180187df903fb82065a9133 (patch) | |
tree | b67ec470765ffab9612a0447714a21d79677620f | |
parent | 649c33560294e76781587781277f984e5adfe8b6 (diff) |
add README.md file as customary for cgit, github, gitlab, etc.
Change-Id: Ide03584aae21d5972e96e7862feb86e1265c29b3
-rw-r--r-- | README.md | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..beb3449 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +osmo-hlr - Osmocom HLR Implementation +===================================== + +This repository contains a C-language implementation of a GSM Home +Location Register (HLR). It is part of the +[Osmocom](https://osmocom.org/) Open Source Mobile Communications +project. + +Warning: While the HLR logical functionality is implemented, OsmoHLR +does not use the ETSI/3GPP TCAP/MAP protocol stack. Instead, a much +simpler custom protocol (GSUP) is used. This means, OsmoHLR is of +no use outside the context of an Osmocom core network. You can use +it with OsmoMSC, OsmoSGSN etc. - but not with third party components. + +Homepage +-------- + +The official homepage of the project is +https://osmocom.org/projects/osmo-hlr/wiki + +GIT Repository +-------------- + +You can clone from the official osmo-hlr.git repository using + + git clone git://git.osmocom.org/osmo-hlr.git + git clone https://git.osmocom.org/osmo-hlr.git + +There is a cgit interface at https://git.osmocom.org/osmo-hlr/ + +Documentation +------------- + +User Manuals and VTY reference manuals are [optionally] built in PDF form +as part of the build process. + +Pre-rendered PDF version of the current "master" can be found at +[User Manual](https://ftp.osmocom.org/docs/latest/osmohlr-usermanual.pdf) +as well as the VTY reference manuals +* [VTY Reference Manual for osmo-hlr](https://ftp.osmocom.org/docs/latest/osmohlr-vty-reference.pdf) + +Mailing List +------------ + +Discussions related to osmo-hlr 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 osmo-hlr can be seen at +https://gerrit.osmocom.org/#/q/project:osmo-hlr+status:open |