Add README.md file

Change-Id: I65ebd735d3c99c47b8f1a88c5a7eb272635d52c3
This commit is contained in:
Pau Espin 2022-02-18 12:41:21 +01:00
parent e88dc911a9
commit bf59e9dc7e
1 changed files with 27 additions and 0 deletions

27
README.md Normal file
View File

@ -0,0 +1,27 @@
= Osmocom DIAMETER -> GSUP translator =
This project implements a proxy translating Diameter into GSUP, hence allowing
Diameter clients connecting to GSUP server. This allows, for instance, using
OsmoHLR as an HSS used by 4G/5G nodes.
== Building ==
Install erlang and rebar3 packages (not "rebar", that's version 2! You may need
to compile it from source in some distros).
$ rebar3 compile
$ rebar3 escriptize
== Testing ==
Unit tests can be run this way:
$ rebar3 eunit
== Running ==
Once osmo_dia2gsup is built, you can start it this way:
$ rebar3 shell
In the erlang shell:
1> osmo_dia2gsup:start().