First release

[sim/ns3-o-ran-e2.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..36c0783
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# ns3-o-ran-e2
+
+================================
+
+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. 
+
+# References
+
+TBD
+<!-- More information can be found in the paper TODO -->
+
+# 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. 
+
+# 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
+- Michele Polese, Northeastern University
+- Tommaso Zugno, University of Padova