aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-03-17 23:26:11 +0100
committerHarald Welte <laforge@gnumonks.org>2017-03-17 23:26:11 +0100
commit60af2f83a5989b03d54e4a68f066ba84c30e8a24 (patch)
treed9f5666f03a925f949cc8312ec162c5183fbd01a
parented3b6f8f2ab290246977fca46a4e838dd017a441 (diff)
add README.md file
-rw-r--r--README.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..23c1d25
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# libgtpnl - netlink library for Linux kernel GTP
+
+In order to control the kernel-side GTP-U plane, a netlink based control
+interface between GTP-C in userspace and GTP-U in kernelspace was
+invented.
+
+The encoding and decoding of these control messages is implemented in
+the libgtpnl (library for GTP netlink).
+
+libgtpnl is part of the [Osmocom](https://osmocom.org/) Open Source
+Mobile Communications project.
+
+## Homepage
+
+The official homepage of the project is
+<https://osmocom.org/projects/libgtpnl/wiki/>
+
+GIT Repository
+--------------
+
+You can clone from the official libgtpnl.git repository using
+
+ git clone git://git.osmocom.org/libgtpnl.git
+
+There is a cgit interface at <http://git.osmocom.org/libgtpnl/>
+
+Mailing List
+------------
+
+Discussions related to libgtpnl are happening on the
+osmocom-net-gprs@lists.osmocom.org mailing list, please see
+<https://lists.osmocom.org/mailman/listinfo/osmocom-net-gprs> 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 use 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 libgtpnl can be seen at
+<https://gerrit.osmocom.org/#/q/project:libgtpnl+status:open>