First release 88/9288/1 h-release master
authorAndrea Lacava <thecave003@gmail.com>
Sun, 25 Sep 2022 12:08:28 +0000 (14:08 +0200)
committerAndrea Lacava <thecave003@gmail.com>
Fri, 14 Oct 2022 20:00:48 +0000 (22:00 +0200)
Change-Id: I386c66d4f85f170a3abf0e774c4baf1acffd9281
Signed-off-by: Andrea Lacava <thecave003@gmail.com>
README.md

index 36c0783..41d733b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,23 +2,27 @@
 
 ================================
 
-This ns-3 module enables the support for running multiple terminations of an O-RAN-compliant E2 interface inside the simulation process. It has been developed by a team at the [Institute for the Wireless Internet of Things (WIoT)](https://wiot.northeastern.edu) at Northeastern University, in collaboration with the University of Padova and with support from Mavenir. 
+This ns-3 module enables the support for running multiple terminations of an O-RAN-compliant E2 interface inside the simulation process. It has been developed as part of a collaborative effort between the [Institute for the Wireless Internet of Things (WIoT)](https://wiot.northeastern.edu) at Northeastern University, Mavenir, and the University of Padova.
 
-# References
+## References
 
-TBD
-<!-- More information can be found in the paper TODO -->
+More information can be found in the paper
 
-# How to use
+> A. Lacava, M. Polese, R. Sivaraj, R. Soundrarajan, B. S. Bhati, T. Singh, T. Zugno, F. Cuomo, T. Melodia "Programmable and Customized Intelligence for Traffic Steering in 5G Networks Using Open RAN Architectures" in arXiv:2209.14171 October 2022 [pdf](https://arxiv.org/pdf/2209.14171.pdf) [bibtex](https://ece.northeastern.edu/wineslab/wines_bibtex/andrea/LacavaAMC22.txt)
+
+## How to use
 
 This module can be used with an extension of the [ns3-mmWave module](https://github.com/nyuwireless-unipd/ns3-mmwave) that will soon be released. The module needs to be cloned in the contrib folder. The [e2sim library](https://github.com/o-ran-sc/sim-e2-interface) needs to be installed.
 
-We will provide further instructions as part of this README file. 
+We will provide further instructions as part of this README file.
 
-# Authors
+## Authors
 
 The ns3-o-ran-e2 module is the result of the development effort carried out by different people. The main contributors are:
 
-- Andrea Lacava, Northeastern University and Sapienza University of Rome
+- Andrea Lacava, Northeastern University and Sapienza, University of Rome
 - Michele Polese, Northeastern University
 - Tommaso Zugno, University of Padova
+- Rajarajan Sivaraj and team, Mavenir
+
+We welcome contributions through pull requests. A contribution guide will be provided soon.