Commit 14900612 authored by dukl's avatar dukl

Update README.md

parent 28af841f
------------------------------------------------------------------------------ # OpenXG-AMF
OPENAIR-CN-5G
An implementation of the 5G Core network by the OpenAirInterface community.
OpenXG-AMF Arch
------------------------------------------------------------------------------
├── build: Build directory, contains targets and object files generated by compilation of network functions.
OPENAIR-CN-5G is an implementation of the 3GPP specifications for the 5G Core Network. ├── log: Directory containing build log files.
At the moment, it contains the following network elements: ├── scripts: Directory containing scripts for building network functions
└── smf: Directory containing CMakefile.txt and object files generated by compilation of AMF network function.
* Access and Mobility Management Function (**AMF**) ├── etc: Directory containing the configuration file to be deployed for AMF.
* Session Management Function (**SMF**) └── src: Source files of AMF.
* User Plane Function (**UPF**) ├── amf-app: AMF Procedures handling logic.
├── common: Common definitions for 3GPP specifications.
Each has its own repository: this repository (`oai-cn5g-amf`) is meant for AMF. ├── contexts: communication contexts used in the AMF.
├── itti: Inter task interface
# Licence info ├── nas: NAS protocol implememtation
├── ngap: NGAP protocol implememtation
It is distributed under `OAI Public License V1.1`. ├── oai_amf: AMF main directory, contains the "main" CMakeLists.txt file.
See [OAI Website for more details](https://www.openairinterface.org/?page_id=698). ├── sbi: AMF service endpoints and curl http client.
├── sctp: Build SCTP server.
The text for `OAI Public License V1.1` is also available under [LICENSE](LICENSE) ├── secu_algorithms: algorithms for 5G-AKA authentication procedures.
file at the root of this repository. ├── test: Minimal implementation for AMF, UDM network functions for testing purpose.
└── utils: Common utilities.  .
# Where to start
## Download source code from Gitlab
The Openair-CN-5G AMF code is written, executed, and tested on UBUNTU server bionic version. git clone http://git.opensource5g.org/openxg/amf.git
Other Linux distributions support will be added later on. cd amf/
git checkout master
More details on the supported feature set is available on this [page](docs/FEATURE_SET.md).
## install dependencies
# Collaborative work cd /amf/build/scripts
./build_amf -I -f
This source code is managed through a GITLAB server, a collaborative development platform: ## build AMF
./build_amf -c -V -b Debug -j
* URL: [https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-amf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-amf). ## launch AMF
sudo amf -c etc/amf.conf -o
Process is explained in [CONTRIBUTING](CONTRIBUTING.md) file. \ No newline at end of file
# Contribution requests
In a general way, anybody who is willing can contribute on any part of the
code in any network component.
Contributions can be simple bugfixes, advices and remarks on the design,
architecture, coding/implementation.
# Release Notes
They are available on the [CHANGELOG](CHANGELOG.md) file.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment