<p>laforge has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/osmo-hlr/+/23440">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">add README.md file as customary for cgit, github, gitlab, etc.<br><br>Change-Id: Ide03584aae21d5972e96e7862feb86e1265c29b3<br>---<br>A README.md<br>1 file changed, 66 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-hlr refs/changes/40/23440/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/README.md b/README.md</span><br><span>new file mode 100644</span><br><span>index 0000000..beb3449</span><br><span>--- /dev/null</span><br><span>+++ b/README.md</span><br><span>@@ -0,0 +1,66 @@</span><br><span style="color: hsl(120, 100%, 40%);">+osmo-hlr - Osmocom HLR Implementation</span><br><span style="color: hsl(120, 100%, 40%);">+=====================================</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+This repository contains a C-language implementation of a GSM Home</span><br><span style="color: hsl(120, 100%, 40%);">+Location Register (HLR). It is part of the</span><br><span style="color: hsl(120, 100%, 40%);">+[Osmocom](https://osmocom.org/) Open Source Mobile Communications</span><br><span style="color: hsl(120, 100%, 40%);">+project.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Warning: While the HLR logical functionality is implemented, OsmoHLR</span><br><span style="color: hsl(120, 100%, 40%);">+does not use the ETSI/3GPP TCAP/MAP protocol stack. Instead, a much</span><br><span style="color: hsl(120, 100%, 40%);">+simpler custom protocol (GSUP) is used.  This means, OsmoHLR is of</span><br><span style="color: hsl(120, 100%, 40%);">+no use outside the context of an Osmocom core network.  You can use</span><br><span style="color: hsl(120, 100%, 40%);">+it with OsmoMSC, OsmoSGSN etc. - but not with third party components.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Homepage</span><br><span style="color: hsl(120, 100%, 40%);">+--------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The official homepage of the project is</span><br><span style="color: hsl(120, 100%, 40%);">+https://osmocom.org/projects/osmo-hlr/wiki</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+GIT Repository</span><br><span style="color: hsl(120, 100%, 40%);">+--------------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+You can clone from the official osmo-hlr.git repository using</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+   git clone git://git.osmocom.org/osmo-hlr.git</span><br><span style="color: hsl(120, 100%, 40%);">+  git clone https://git.osmocom.org/osmo-hlr.git</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+There is a cgit interface at https://git.osmocom.org/osmo-hlr/</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Documentation</span><br><span style="color: hsl(120, 100%, 40%);">+-------------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+User Manuals and VTY reference manuals are [optionally] built in PDF form</span><br><span style="color: hsl(120, 100%, 40%);">+as part of the build process.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Pre-rendered PDF version of the current "master" can be found at</span><br><span style="color: hsl(120, 100%, 40%);">+[User Manual](https://ftp.osmocom.org/docs/latest/osmohlr-usermanual.pdf)</span><br><span style="color: hsl(120, 100%, 40%);">+as well as the VTY reference manuals</span><br><span style="color: hsl(120, 100%, 40%);">+* [VTY Reference Manual for osmo-hlr](https://ftp.osmocom.org/docs/latest/osmohlr-vty-reference.pdf)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Mailing List</span><br><span style="color: hsl(120, 100%, 40%);">+------------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Discussions related to osmo-hlr are happening on the</span><br><span style="color: hsl(120, 100%, 40%);">+openbsc@lists.osmocom.org mailing list, please see</span><br><span style="color: hsl(120, 100%, 40%);">+https://lists.osmocom.org/mailman/listinfo/openbsc for subscription</span><br><span style="color: hsl(120, 100%, 40%);">+options and the list archive.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Please observe the [Osmocom Mailing List</span><br><span style="color: hsl(120, 100%, 40%);">+Rules](https://osmocom.org/projects/cellular-infrastructure/wiki/Mailing_List_Rules)</span><br><span style="color: hsl(120, 100%, 40%);">+when posting.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Contributing</span><br><span style="color: hsl(120, 100%, 40%);">+------------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Our coding standards are described at</span><br><span style="color: hsl(120, 100%, 40%);">+https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+We us a gerrit based patch submission/review process for managing</span><br><span style="color: hsl(120, 100%, 40%);">+contributions.  Please see</span><br><span style="color: hsl(120, 100%, 40%);">+https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit for</span><br><span style="color: hsl(120, 100%, 40%);">+more details</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The current patch queue for osmo-hlr can be seen at</span><br><span style="color: hsl(120, 100%, 40%);">+https://gerrit.osmocom.org/#/q/project:osmo-hlr+status:open</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-hlr/+/23440">change 23440</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/osmo-hlr/+/23440"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: osmo-hlr </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: Ide03584aae21d5972e96e7862feb86e1265c29b3 </div>
<div style="display:none"> Gerrit-Change-Number: 23440 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>