[M] Change in ...osmo_dia2gsup[master]: README.md: update

osmith has submitted this change. ( https://gerrit.osmocom.org/c/erlang/osmo_dia2gsup/+/34196 ) Change subject: README.md: update ...................................................................... README.md: update Fix the broken formatting (wrong headlines, missing line breaks in blocks of commands) and move the configuration and escript sections below the running section. Add the command that fixeria suggested for running it with one shell command. Old: https://gitea.osmocom.org/erlang/osmo_dia2gsup/src/branch/master/README.md New: https://gitea.osmocom.org/osmith/osmo_dia2gsup/src/branch/master/README.md Change-Id: Ib96f42ca0066ba2f6d0d783f6bf1764cbfee544f --- M README.md 1 file changed, 39 insertions(+), 11 deletions(-) Approvals: pespin: Looks good to me, but someone else must approve Jenkins Builder: Verified fixeria: Looks good to me, approved diff --git a/README.md b/README.md index 3177caf..8d8dc01 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,51 @@ -= Osmocom DIAMETER -> GSUP translator = +# 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 == +## 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 == +## Testing Unit tests can be run this way: +``` $ rebar3 eunit +``` -== Running == +## Running Once osmo\_dia2gsup is built, you can start it this way: +``` $ rebar3 shell - -In the erlang shell: -``` 1> osmo_dia2gsup:start(). ``` -== Configuration == +Passing a config file: +``` $ rebar3 shell --config ./examples/sys.config -``` 1> osmo_dia2gsup:start(). ``` -== Run as an escript == +Running it with one shell command: +``` +$ rebar3 shell --config ./examples/sys.config --eval "osmo_dia2gsup:start()." +``` + +Running it as an escript: + +``` $ rebar3 escriptize $ ERL_FLAGS='-config ./examples/sys.config' _build/default/bin/osmo-dia2gsup - +``` -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo_dia2gsup/+/34196 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: erlang/osmo_dia2gsup Gerrit-Branch: master Gerrit-Change-Id: Ib96f42ca0066ba2f6d0d783f6bf1764cbfee544f Gerrit-Change-Number: 34196 Gerrit-PatchSet: 2 Gerrit-Owner: osmith <osmith(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: osmith <osmith(a)sysmocom.de> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: merged