From 5b93ddeaae3ff5f9615c3bd5331b5b3c25e875f2 Mon Sep 17 00:00:00 2001
From: nickvsnetworking <nick@nickvsnetworking.com>
Date: Sun, 4 Oct 2020 15:50:36 +1100
Subject: [PATCH] Updated Readme to include more complete instructions

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++--
 1 file changed, 39 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7d094c8..1a9a1c8 100644
--- a/README.md
+++ b/README.md
@@ -53,18 +53,55 @@ S1APTester binary can be generated by executing below compilation steps:
 $ cd TestCntlrApp/build
 $ make cleanall
 $ make
+$ sudo cp ../lib/libtfw.so /usr/lib
+$ cd ../../
 ```
 On successful compilation, the “libtfw.so” library gets generated under
-TestCntlrApp/lib folder.
+TestCntlrApp/lib folder which is copied to ``/usr/lib``.
 
 ##	Compile Traffic Generator
 ```
 $ cd Trfgen/build
 $ make clean
 $ make
+$ sudo cp ../lib/libtrfgen.so /usr/lib
+$ cd ../../
 ```
 On successful compilation, the “libtrfgen.so” library gets generated under
-Trfgen/lib folder.
+Trfgen/lib folder which is copied to ``/usr/lib``.
+
+## Compile Test Controller Stub
+```
+$ cd TestCntlrStub/build
+$ make clean
+$ make
+$ cd ../bin/
+```
+Upon successful compilation, an executable binary ``testCntrlr`` is created in the ``bin`` directory.
+
+
+## Configure eNodeB Parameters
+Example eNodeB configuration file can be found in ``TestCntlrApp/cfg/nbAppCfg.txt``,
+
+In this file you will need to put in the parameters for your EPC, such as Cell ID, TAC, MCC/MNC, IP Addresses, etc.
+
+## Configure UE Parameters
+Example UE parameter file can be found in ``TestCntlrApp/cfg/ueCfg.txt``,
+
+In this file you will need to put in the crypto parameters for your HSS, such as OP key and K Keys.
+
+Each IMSI you want to test will need to be defined in  ``TestCntlrApp/cfg/imsi.txt``
+
+## Running S1AP Test
+After configuring your eNodeB & UE parameters, you can run the ``TestCntlrStub`` with one of the example test cases,
+```
+$ cd TestCntlrStub/bin
+$ sudo ./testCntrlr -f testCaseList_1.txt
+```
+
+Log messages will be shown on screen and in the text file ``log`` created in the same directory.
+
+
 
 # Testing with Magma
 Following points should be considered when using S1APTester with