Release A code commit

[o-du/l2.git] / README

diff --git a/README b/README
index 71fbd36..1ec3744 100644 (file)
--- a/README
+++ b/README
@@ -4,27 +4,33 @@ Directory Structure :
    a. common : contains individual module's makefile
    b. config : contains SSI memory configuration
    c. odu    : contains main makefile to generate an executable binary
-   b. scripts : contains scripts required for compilation
        
 2. 5gnr_opensource/src/ : contains layer specific source code
-   a. 5gnrmac : MAC source code
-   b.  5gnrrlc : RLC source code
-   c. cm : common, environment and interface files
-   d. cu_app : Stub code for CU
-   e. du_app : DU application and F1 code 
-   f. mt : wrapper functions over OS
+   a. 5gnrmac  : MAC source code
+   b.  5gnrrlc  : RLC source code
+   c. cm       : common, environment and interface files
+   d. cu_stub  : Stub code for CU
+   e. du_app   : DU application and F1 code 
+   f. mt       : wrapper functions over OS
    g. phy_stub : Stub code for Physical layer
-   h. rlog : logging module
+   h. rlog     : logging module
 
 
 Pre-requisite for Compilation :
 1. Linux 32-bit/64-bit machine
 2. GCC version 4.6.3 and above
-3. Copy ASN code generated for F1 messages into 5gnr_opensource/src/du_app/F1AP/asn/
 
-How to Compile :
+How to Compile:
 1. cd 5gnr_opensource/build/odu
-2. To clean and compile: make clean_all odu  MACHINE=BIT64 TEXT_LOG=YES
-3. To clean only, run command : make clean_all MACHINE=BIT64 TEXT_LOG=YES
+2. To clean and compile: 
+    a. DU : make clean_all odu  MACHINE=BIT64 TEXT_LOG=YES MODE=FDD
+    b. CU : make clean_cu cu_stub MACHINE=BIT64 TEXT_LOG=YES MODE=FDD 
+
+How to execute:
+1. DU :
+    a. cd 5gnr_opensource/build/odu/bin/odu
+    b. ./odu -f ../config/ssi_mem
+2. CU :
+    a. cd 5gnr_opensource/build/odu/bin/cu_stub
+    b. ./cu_stub -f ../config/ssi_mem
 
-Executable binary generated : 5gnr_opensource/build/odu/obj/odu