[MERGED] libsmpp34[master]: Actually fill the README file with contents (and markdown sy...

[Harald Welte]

Harald Welte has submitted this change and it was merged.

Change subject: Actually fill the README file with contents (and markdown syntax)
......................................................................


Actually fill the README file with contents (and markdown syntax)

Change-Id: I2343b2fd45d00935c0e27c84e8b55c39765d51f8
---
M Makefile.am
D README
A README.md
M configure.ac
4 files changed, 65 insertions(+), 2 deletions(-)

Approvals:
  Harald Welte: Looks good to me, approved
  Jenkins Builder: Verified



diff --git a/Makefile.am b/Makefile.am
index 7f175ba..752e34e 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -10,7 +10,8 @@
              test_apps/pack_and_send.inc\
              test_apps/esme.xml\
              test_apps/sendwp.xml\
-             test_apps/recv_and_unpack.inc
+             test_apps/recv_and_unpack.inc \
+             README.md
 
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = libsmpp34.pc
diff --git a/README b/README
deleted file mode 100644
index e69de29..0000000
--- a/README
+++ /dev/null
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5c0e8af
--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+libsmpp34 - C library for SMPP 3.4
+==================================
+
+This repository contains a C-language library implementing the SMPP
+Protocol version 3.4 as specified by the SMPP Developers Forum.
+
+The library was inherited from the
+[c-open-smmp34](https://sourceforge.net/projects/c-open-smpp-34/)
+project, which unfortunately doesn't have any form of revision control
+system and hence the [Osmocom](https://osmocom.org/) Open Source
+Mobile Communications project has imported the v1.10 release into this
+git repository and performed subsequent improvements.
+
+Homepage
+--------
+
+The official homepage of the Osmocom version of the library is
+http://osmocom.org/projects/libsmpp34
+while the original upstream project is found at
+https://sourceforge.net/projects/c-open-smpp-34/
+
+GIT Repository
+--------------
+
+You can clone from the Osmocom libsmpp34.git repository using
+
+	git clone git://git.osmocom.org/libsmpp34.git
+
+There is a cgit interface at http://git.osmocom.org/libsmpp34/
+
+Documentation
+-------------
+
+API documentation is generated during the build
+process, but also available online from the upstream project at
+http://c-open-smpp-34.sourceforge.net/out-1.10/web/c-open-libsmpp34_en/index.html
+
+Mailing List
+------------
+
+Discussions related to libsmpp34 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 libosmocore can be seen at
+https://gerrit.osmocom.org/#/q/project:libsmpp34+status:open
diff --git a/configure.ac b/configure.ac
index 0d84ffc..9f816bb 100644
--- a/configure.ac
+++ b/configure.ac
@@ -4,7 +4,7 @@
 AC_PREREQ(2.57)
 AC_INIT(libsmpp34, 1.10, ultraismo at yahoo.com)
 AC_CONFIG_AUX_DIR(aux_config)
-AM_INIT_AUTOMAKE
+AM_INIT_AUTOMAKE([foreign])
 AM_CONFIG_HEADER([aux_config/config.h])
 
 # Checks for programs.

-- 
To view, visit https://gerrit.osmocom.org/2105
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I2343b2fd45d00935c0e27c84e8b55c39765d51f8
Gerrit-PatchSet: 2
Gerrit-Project: libsmpp34
Gerrit-Branch: master
Gerrit-Owner: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder