aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-03-17 22:49:14 +0100
committerHarald Welte <laforge@gnumonks.org>2017-03-17 22:49:14 +0100
commit6fde8e1c26f12069e67103ba5f69a068d78de063 (patch)
treeee7c2db65fcf159b8ef0563de47ed0d7e0bdf862
parent197ed82a32459d6ff64d9f97b0dbc36ce8b72c67 (diff)
update README with current information + convert to MarkdownHEADmaster
-rw-r--r--README13
-rw-r--r--README.md56
2 files changed, 56 insertions, 13 deletions
diff --git a/README b/README
deleted file mode 100644
index ba22712..0000000
--- a/README
+++ /dev/null
@@ -1,13 +0,0 @@
-Osmocom SIMTRACE
-======================================================================
-(C) 2010 by Harald Welte <laforge@gnumonks.org>
-
-SIMTRACE is a program that can be used for tracing the communication
-betewen a phone and the SIM card. More generally, it can trace any
-ISO 7816 based smart card interface.
-
-This repository contains a host program 'simtrace' as well as a patch
-for wireshark.
-
-The corresponding device firmware can be found in the openpcd.git
-repository on git.gnumonks.org.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..469b177
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# Osmocom SIMtrace
+
+(C) 2010-2017 by Harald Welte <laforge@gnumonks.org>
+
+SIMTtraceis a program that can be used for tracing the communication
+between a phone and the SIM card. More generally, it can trace any
+ISO 7816 based smart card interface.
+
+SIMtrace is part of the [Osmocom](https://osmocom.org/) Open Source
+Mobile Communications project.
+
+This repository contains a host program 'simtrace' as well as a patch
+for wireshark (which is part of mainline wireshark since February 2012)
+
+The corresponding device firmware source code can be found at
+<http://git.osmocom.org/openpcd/>
+
+## Homepage
+
+The official homepage of the project is
+<https://osmocom.org/projects/simtrace/wiki/>
+
+GIT Repository
+--------------
+
+You can clone from the official simtrace.git repository using
+
+ git clone git://git.osmocom.org/simtrace.git
+
+There is a cgit interface at <http://git.osmocom.org/simtrace/>
+
+## Documentation
+
+There is a PDF user manual available from
+<https://osmocom.org/attachments/download/2139/usermanual.pdf>
+
+Mailing List
+------------
+
+Discussions related to simtrace are happening on the
+simtrace@lists.osmocom.org mailing list, please see
+<https://lists.osmocom.org/mailman/listinfo/simtrace> 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 e-mail based patch submission/review process on the
+above-mentioned mailing list for contributions.