aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..de85ca1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+libosmo-pfcp - PFCP protocol encoding and decoding, and generic PFCP endpoint implementation
+============================================================================================
+
+Homepage
+--------
+
+The official homepage of the project is
+https://osmocom.org/projects/libosmo-pfcp
+
+GIT Repository
+--------------
+
+You can clone from the official libosmo-pfcp.git repository using
+
+ git clone git://git.osmocom.org/libosmo-pfcp.git
+
+To submit patches, see "Contributing" below.
+
+Mailing List
+------------
+
+Discussions related to libosmo-pfcp are happening on the
+osmocom-net-gprs@lists.osmocom.org mailing list, please see
+https://lists.osmocom.org/postorius/lists/osmocom-net-gprs@lists.osmocom.org/
+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
+
+Submit patches at https://gerrit.osmocom.org/
+See also https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit
+
+The current patch queue for libosmo-pfcp can be seen at
+https://gerrit.osmocom.org/#/q/project:libosmo-pfcp+status:open