cellular-infrastructure
/
osmo-cbc
mirror of https://gerrit.osmocom.org/osmo-cbc
9
0
Fork 0
Code Issues Releases Wiki Activity

Add README.md file 

Change-Id: Ib2a019290a80d67e26875d972f6a8ee700f73bb6
This commit is contained in:
Harald Welte 2021-01-22 20:14:55 +01:00
parent d1c50f54cd
commit e88eceb790
2 changed files with 70 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile.am
View File

@ -3,7 +3,7 @@ AUTOMAKE_OPTIONS = foreign dist-bzip2 1.6
AM_CPPFLAGS = $(all_includes) -I$(top_srcdir)/include
SUBDIRS = src doc contrib tests
EXTRA_DIST = .version git-version-gen contrib/osmo-cbc.spec.in
EXTRA_DIST = .version README.md git-version-gen contrib/osmo-cbc.spec.in
AM_DISTCHECK_CONFIGURE_FLAGS = \
--with-systemdsystemunitdir=$$dc_install_base/$(systemdsystemunitdir)

69
README.md Normal file
View File

@ -0,0 +1,69 @@
osmo-cbc - Osmocom Cell Broadcast Centre
========================================
This repository contains a C-language implementation of a minimal
3GPP Cell Broadcast Centre (CBC). It is part of the
[Osmocom](https://osmocom.org/) Open Source Mobile Communications
project.
A Cell Broadcast Centre is the central network element of a cellular network
for distribution of Cell Broadcast and Emergency messages.
This code implements
* the CBSP protocol on the CBC-BSC interface
* a custom HTTP/REST based interface for external users to create/delete CBS messages
We plan to add support for the following features in the future:
* the SABP protocol on the CBC-RNC (or CBC-HNBGW) interface for UMTS support
* the SBcAP protocol on the CBC-MME interface for LTE support
Homepage
--------
The official homepage of the project is
https://osmocom.org/projects/osmo-cbc/wiki
GIT Repository
--------------
You can clone from the official osmo-cbc.git repository using
git clone https://git.osmocom.org/osmo-cbc.git
There is a cgit interface at https://git.osmocom.org/osmo-cbc/
Documentation
-------------
User Manuals and VTY reference manuals are [optionally] built in PDF form
as part of the build process.
Pre-rendered PDF version of the current "master" can be found at
[User Manual](https://ftp.osmocom.org/docs/latest/osmocbc-usermanual.pdf)
as well as the [VTY Reference Manual for osmo-cbc](https://ftp.osmocom.org/docs/latest/osmocbc-vty-reference.pdf)
Mailing List
------------
Discussions related to osmo-cbc are happening on the
openbsc@lists.osmocom.org mailing list, please see
https://lists.osmocom.org/mailman/listinfo/openbsc for subscription
options and the list archive.
Please observe the [Osmocom Mailing List
Rules](https://osmocom.org/projects/cellular-infrastructure/wiki/Mailing_List_Rules)
when posting.
Contributing
------------
Our coding standards are described at
https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards
We us a gerrit based patch submission/review process for managing
contributions. Please see
https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit for
more details
The current patch queue for osmo-cbc can be seen at
https://gerrit.osmocom.org/#/q/project:osmo-cbc+status:open