summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuval Adam <yuv.adm@gmail.com>2013-01-27 23:41:08 +0200
committerYuval Adam <yuv.adm@gmail.com>2013-01-27 23:43:49 +0200
commitcaae51230500f749e2ec403f1abb2e7685f87cf9 (patch)
tree37d9e2bc780118c85e958fa5c7c7441c92a57c15
parent18d67880cbc09256f37c8257a9635c3d3f98ad73 (diff)
Add initial README
-rw-r--r--README4
-rw-r--r--README.md12
2 files changed, 12 insertions, 4 deletions
diff --git a/README b/README
deleted file mode 100644
index ed4d167..0000000
--- a/README
+++ /dev/null
@@ -1,4 +0,0 @@
-DumPOCASG
-=========
-
-A dump1090-inspired tool for dumping POCSAG messages.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..71f12cf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Gascop
+
+Gascop is a lightweight POCSAG decoder for use with [rtl-sdr](http://sdr.osmocom.org/trac/wiki/rtl-sdr) devices heavily inspired by [dump1090](https://github.com/antirez/dump1090/) and is currently under development mainly as an exercise in processing data from rtl-sdr devices.
+
+## Build
+
+ $ make
+
+## Use
+
+ $ ./gascop
+