diff --git a/README.md b/README.md index 7651aea5c998e7a55b2096d1562487d5155183b5..59b4a5a301fb5e68acb8702d1efc550f25358bb4 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,3 @@ -# OpenAirInterface License # +# OpenXG-RAN -OpenAirInterface is under OpenAirInterface Software Alliance license. - - * [OAI License Model](http://www.openairinterface.org/?page_id=101) - * [OAI License v1.1 on our website](http://www.openairinterface.org/?page_id=698) - -It is distributed under **OAI Public License V1.1**. - -The license information is distributed under [LICENSE](LICENSE) file in the same directory. - -Please see [NOTICE](NOTICE.md) file for third party software that is included in the sources. - -# Where to Start # - - * [The implemented features](./doc/FEATURE_SET.md) - * [How to build](./doc/BUILD.md) - * [How to run the modems](./doc/RUNMODEM.md) - -# RAN repository structure # - -The OpenAirInterface (OAI) software is composed of the following parts: - -<pre> -openairinterface5g -鈹溾攢鈹€ ci-scripts : Meta-scripts used by the OSA CI process. Contains also configuration files used day-to-day by CI. -鈹溾攢鈹€ cmake_targets : Build utilities to compile (simulation, emulation and real-time platforms), and generated build files. -鈹溾攢鈹€ common : Some common OAI utilities, other tools can be found at openair2/UTILS. -鈹溾攢鈹€ doc : Contains an up-to-date feature set list and starting tutorials. -鈹溾攢鈹€ executables : Top-level executable source files. -鈹溾攢鈹€ LICENSE : License file. -鈹溾攢鈹€ maketags : Script to generate emacs tags. -鈹溾攢鈹€ nfapi : Contains the NFAPI code. A local Readme file provides more details. -鈹溾攢鈹€ openair1 : 3GPP LTE Rel-10/12 PHY layer / 3GPP NR Rel-15 layer. A local Readme file provides more details. -鈹偮犅� 鈹溾攢鈹€ PHY -鈹偮犅� 鈹溾攢鈹€ SCHED -鈹偮犅� 鈹溾攢鈹€ SCHED_NBIOT -鈹偮犅� 鈹溾攢鈹€ SCHED_NR -鈹偮犅� 鈹溾攢鈹€ SCHED_NR_UE -鈹偮犅� 鈹溾攢鈹€ SCHED_UE -鈹偮犅� 鈹斺攢鈹€ SIMULATION : PHY RF simulation. -鈹溾攢鈹€ openair2 : 3GPP LTE Rel-10 RLC/MAC/PDCP/RRC/X2AP + LTE Rel-14 M2AP implementation. Also 3GPP NR Rel-15 RLC/MAC/PDCP/RRC/X2AP. -鈹偮犅� 鈹溾攢鈹€ COMMON -鈹偮犅� 鈹溾攢鈹€ DOCS -鈹偮犅� 鈹溾攢鈹€ ENB_APP -鈹偮犅� 鈹溾攢鈹€ F1AP -鈹偮犅� 鈹溾攢鈹€ GNB_APP -鈹偮犅� 鈹溾攢鈹€ LAYER2/RLC/ : with the following subdirectories: UM_v9.3.0, TM_v9.3.0, and AM_v9.3.0. -鈹偮犅� 鈹溾攢鈹€ LAYER2/PDCP/PDCP_v10.1.0 -鈹偮犅� 鈹溾攢鈹€ M2AP -鈹偮犅� 鈹溾攢鈹€ MCE_APP -鈹偮犅� 鈹溾攢鈹€ NETWORK_DRIVER -鈹偮犅� 鈹溾攢鈹€ NR_PHY_INTERFACE -鈹偮犅� 鈹溾攢鈹€ NR_UE_PHY_INTERFACE -鈹偮犅� 鈹溾攢鈹€ PHY_INTERFACE -鈹偮犅� 鈹溾攢鈹€ RRC -鈹偮犅� 鈹溾攢鈹€ UTIL -鈹偮犅� 鈹斺攢鈹€ X2AP -鈹溾攢鈹€ openair3 : 3GPP LTE Rel10 for S1AP, NAS GTPV1-U for both ENB and UE. -鈹偮犅� 鈹溾攢鈹€ COMMON -鈹偮犅� 鈹溾攢鈹€ DOCS -鈹偮犅� 鈹溾攢鈹€ GTPV1-U -鈹偮犅� 鈹溾攢鈹€ M3AP -鈹偮犅� 鈹溾攢鈹€ MME_APP -鈹偮犅� 鈹溾攢鈹€ NAS -鈹偮犅� 鈹溾攢鈹€ S1AP -鈹偮犅� 鈹溾攢鈹€ SCTP -鈹偮犅� 鈹溾攢鈹€ SECU -鈹偮犅� 鈹溾攢鈹€ TEST -鈹偮犅� 鈹溾攢鈹€ UDP -鈹偮犅� 鈹斺攢鈹€ UTILS -鈹斺攢鈹€ targets : Top-level wrappers for unitary simulation for PHY channels, system-level emulation (eNB-UE with and without S1), and realtime eNB and UE and RRH GW. -</pre> +OpenXG-RAN is originally forked from OpenAirInterface, and evolves at its own step.