Change in osmo-cbc[master]: Add README.md file

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.

laforge gerrit-no-reply at lists.osmocom.org
Fri Jan 22 19:16:29 UTC 2021


laforge has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-cbc/+/22390 )


Change subject: Add README.md file
......................................................................

Add README.md file

Change-Id: Ib2a019290a80d67e26875d972f6a8ee700f73bb6
---
M Makefile.am
A README.md
2 files changed, 70 insertions(+), 1 deletion(-)



  git pull ssh://gerrit.osmocom.org:29418/osmo-cbc refs/changes/90/22390/1

diff --git a/Makefile.am b/Makefile.am
index 7a549f2..4037bb1 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -3,7 +3,7 @@
 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)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..12a6b1f
--- /dev/null
+++ b/README.md
@@ -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 at 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

-- 
To view, visit https://gerrit.osmocom.org/c/osmo-cbc/+/22390
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-cbc
Gerrit-Branch: master
Gerrit-Change-Id: Ib2a019290a80d67e26875d972f6a8ee700f73bb6
Gerrit-Change-Number: 22390
Gerrit-PatchSet: 1
Gerrit-Owner: laforge <laforge at osmocom.org>
Gerrit-MessageType: newchange
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20210122/944e4b5b/attachment.htm>


More information about the gerrit-log mailing list