osmith has uploaded this change for review.

View Change

README.md: fix markdown formatting

Fix the broken formatting (wrong headlines, missing line breaks in
blocks of commands) and move the configuration and escript sections
below the running section.

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, 30 insertions(+), 11 deletions(-)

git pull ssh://gerrit.osmocom.org:29418/erlang/osmo_dia2gsup refs/changes/96/34196/1

diff --git a/README.md b/README.md
index 3177caf..bd8af46 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,45 @@
-= 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 as an escript in one shell command:
 
+```
 $ rebar3 escriptize
 $ ERL_FLAGS='-config ./examples/sys.config' _build/default/bin/osmo-dia2gsup
-
+```

To view, visit change 34196. To unsubscribe, or for help writing mail filters, visit settings.