/5G

5G Mobile Networks -- Micro-book

Primary LanguagePythonOtherNOASSERTION

About The Book

This repository contains source for 5G Mobile Networks: A Systems Approach, available under terms of the Creative Commons (CC BY-NC-ND 4.0) license. The community is invited to contribute corrections, improvements, updates, and new material under the same terms.

If you make use of this work, the attribution should include the following information:

Title: 5G Mobile Networks: A Systems Approach
Authors: Larry Peterson and Oguz Sunay
Source: https://github.com/SystemsApproach/5G
License: CC BY-NC-ND 4.0

Read the Book

This book is part of the Systems Approach Series, with an online version published at https://5G.systemsapproach.org.

To track progress and receive notices about new versions, you can follow the project on Facebook and Twitter. To read a running commentary on how the Internet is evolving, follow the Systems Approach on Substack.

Build the Book

To build a web-viewable version, you first need to download the source:

$ mkdir ~/5G
$ cd ~/5G
$ git clone https://github.com/SystemsApproach/5G.git

The build process is stored in the Makefile and requires Python be installed. The Makefile will create a virtualenv (doc_venv) which installs the documentation generation toolset.

To generate HTML in _build/html, run make html.

To check the formatting of the book, run make lint.

To see the other available output formats, run make.

Contribute to the Book

We hope that if you use this material, you are also willing to contribute back to it. If you are new to open source, you might check out this How to Contribute to Open Source guide. Among other things, you’ll learn about posting Issues that you’d like to see addressed, and issuing Pull Requests to merge your improvements back into GitHub.

If you’d like to contribute and are looking for something that needs attention, see the wiki for the current TODO list.