maki/openairinterface5g
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DOC: added link to feature list in README

Browse Source 
align folder structure in README w/ 5G-NR new folders

Signed-off-by: Raphael Defosseux <raphael.defosseux@eurecom.fr>
This commit is contained in:
Raphael Defosseux
2020-02-11 16:59:43 +01:00
parent 0b4726751e
commit f8037ab61e
1 changed files with 48 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+44 -30
View File
@@ -13,6 +13,7 @@ Please see [NOTICE](NOTICE.md) file for third party software that is included in
# Where to Start # # Where to Start #
* [The implemented features](./doc/FEATURE_SET.md)
* [How to build](./doc/BUILD.md) * [How to build](./doc/BUILD.md)
* [How to run the modems](./doc/RUNMODEM.md) * [How to run the modems](./doc/RUNMODEM.md)
@@ -23,37 +24,50 @@ The OpenAirInterface (OAI) software is composed of the following parts:
<pre> <pre>
openairinterface5g openairinterface5g
├── ci-scripts : Meta-scripts used by the OSA CI process. Contains also configuration files used day-to-day by CI. ├── 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 ├── 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 ├── common : Some common OAI utilities, other tools can be found at openair2/UTILS.
├── doc : Contains an up-to-date feature set list ├── doc : Contains an up-to-date feature set list and starting tutorials.
├── LICENSE ├── executables : Top-level executable source files.
├── maketags : Script to generate emacs tags ├── LICENSE : License file.
├── maketags : Script to generate emacs tags.
├── nfapi : Contains the NFAPI code. A local Readme file provides more details. ├── nfapi : Contains the NFAPI code. A local Readme file provides more details.
├── openair1 : 3GPP LTE Rel-10/12 PHY layer + PHY RF simulation. 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.
├── openair2 : 3GPP LTE Rel-10 RLC/MAC/PDCP/RRC/X2AP + LTE Rel-14 M2AP implementation. │   ├── PHY
├── COMMON │   ├── SCHED
├── DOCS │   ├── SCHED_NBIOT
├── ENB_APP │   ├── SCHED_NR
├── LAYER2/RLC/ with the following subdirectories: UM_v9.3.0, TM_v9.3.0, and AM_v9.3.0. │   ├── SCHED_NR_UE
├── LAYER2/PDCP/PDCP_v10.1.0. │   ├── SCHED_UE
├── NETWORK_DRIVER │   └── SIMULATION : PHY RF simulation.
├── PHY_INTERFACE ├── 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.
├── RRC/LITE │   ├── COMMON
├── UTIL │   ├── DOCS
├── X2AP │   ├── ENB_APP
├── M2AP │   ├── F1AP
├── MCE_APP │   ├── 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. ├── openair3 : 3GPP LTE Rel10 for S1AP, NAS GTPV1-U for both ENB and UE.
├── COMMON │   ├── COMMON
├── DOCS │   ├── DOCS
├── GTPV1-U │   ├── GTPV1-U
├── NAS │   ├── M3AP
├── S1AP │   ├── MME_APP
├── M3AP │   ├── NAS
├── SCTP │   ├── S1AP
├── SECU │   ├── SCTP
├── UDP │   ├── SECU
├── UTILS │   ├── 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. └── 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> </pre>