Commit dd4ec775 authored by aligungr's avatar aligungr

README.md updated

parent 20831711
...@@ -2,19 +2,24 @@ ...@@ -2,19 +2,24 @@
<a href="https://github.com/aligungr/UERANSIM"><img src="/.github/logo.png" width="75" title="UERANSIM"></a> <a href="https://github.com/aligungr/UERANSIM"><img src="/.github/logo.png" width="75" title="UERANSIM"></a>
</p> </p>
<p align="center"> <p align="center">
<img src="https://img.shields.io/badge/UERANSIM-v3.1.1-blue" /> <img src="https://img.shields.io/badge/UERANSIM-v3.1.2-blue" />
<img src="https://img.shields.io/badge/3GPP-R15-orange" /> <img src="https://img.shields.io/badge/3GPP-R15-orange" />
<img src="https://img.shields.io/badge/License-GPL--3.0-green"/> <img src="https://img.shields.io/badge/License-GPL--3.0-green"/>
</p> </p>
**UERANSIM** <small>(pronounced "ju-i ræn sɪm")</small>, is the open-source state-of-the-art 5G UE and RAN (gNodeB) implementation. It can be considered as a 5G mobile phone and a base station in basic terms. The project can be used for testing 5G Core Network and studying 5G System. **UERANSIM** <small>(pronounced "ju-i ræn sɪm")</small>, is the open-source state-of-the-art 5G UE and RAN (gNodeB)
implementation. It can be considered as a 5G mobile phone and a base station in basic terms. The project can be used for
testing 5G Core Network and studying 5G System.
## Current Status ## Current Status
Our UE and gNodeB are functional and ready to use. You can connect them to your 5G core network right now and start using it.
Our UE and gNodeB are functional and ready to use. You can connect them to your 5G core network right now and start
using it.
In terms of 3GPP coverage, fundamental control plane features are done. However, some of them are in progress. In terms of 3GPP coverage, fundamental control plane features are done. However, some of them are in progress.
At the same time, 5G-NR radio interface is under development but not complete yet. Currently we utilize the radio interface over a simulated environment. At the same time, 5G-NR radio interface is under development but not complete yet. Currently we utilize the radio
interface over a simulated environment.
<p align="center"> <p align="center">
<img src="https://img.shields.io/badge/5G%20Radio%20Interface-in%20progress-orange" alt="OS Linux"/> <img src="https://img.shields.io/badge/5G%20Radio%20Interface-in%20progress-orange" alt="OS Linux"/>
...@@ -23,20 +28,28 @@ At the same time, 5G-NR radio interface is under development but not complete ye ...@@ -23,20 +28,28 @@ At the same time, 5G-NR radio interface is under development but not complete ye
</p> </p>
## Documentation ## Documentation
You can find the documentation on [UERANSIM Wiki](https://github.com/aligungr/UERANSIM/wiki). You can find the documentation on [UERANSIM Wiki](https://github.com/aligungr/UERANSIM/wiki).
And, since the project is rapidly developing, please make sure that you have always the [latest](https://github.com/aligungr/UERANSIM/releases) UERANSIM. And, since the project is rapidly developing, please make sure that you have always
the [latest](https://github.com/aligungr/UERANSIM/releases) UERANSIM.
## Contributing ## Contributing
Implementing UE and RAN is not an easy task and is very time-consuming. We are always open to public contributions and pull requests. Implementing UE and RAN is not an easy task and is very time-consuming. We are always open to public contributions and
pull requests.
## Supporting ## Supporting
UERANSIM is the first and currently only open source project that implements 5G-SA UE and RAN. Commercial alternatives of this software cost hundreds of thousands of dollars. You can support this free and open source software by: UERANSIM is the first and currently only open source project that implements 5G-SA UE and RAN. Commercial alternatives
of this software cost hundreds of thousands of dollars. You can support this free and open source software by:
- Donating on [Open Collective](https://opencollective.com/UERANSIM)
- Starring our GitHub repository, - Starring our GitHub repository,
- Creating pull requests, submitting bugs, suggesting new features or documentation updates. - Creating pull requests, submitting bugs, suggesting new features or documentation updates.
## License ## License
Copyright (c) 2021 ALİ GÜNGÖR. All source code and related files including documentation and wiki pages are licensed under [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), see [LICENSE](https://github.com/aligungr/UERANSIM/blob/master/LICENSE) for more details. Copyright (c) 2021 ALİ GÜNGÖR. All source code and related files including documentation and wiki pages are licensed
under [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.en.html),
see [LICENSE](https://github.com/aligungr/UERANSIM/blob/master/LICENSE) for more details.
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