aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fc9d80a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+gapk - GSM Audio Pocket Knife
+=============================
+
+The GSM Audio Picket Knife is a tool that can help you to convert
+codec frames of all codecs in GSM networks between a variety of
+different formats / representations.
+
+It is part of the [Osmocom](https://osmocom.org/) Open Source Mobile
+Communications project.
+
+GIT Repository
+--------------
+
+You can clone from the official gapk.git repository using
+
+ git clone git://git.osmocom.org/gapk.git
+ git clone https://git.osmocom.org/gapk.git
+
+There is a cgit interface at https://git.osmocom.org/gapk/
+
+Documentation
+-------------
+
+Unfortunately none.
+
+Mailing List
+------------
+
+Discussions related to gapk 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.