aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..407d7bf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+quikgrok - Real-time pipeline protocol decoders
+===============================================
+
+quikgrok is a suite of very simple C based filters designed to used in
+live shell pipes.
+
+Usage
+-----
+
+Offline decode of a capture file:
+
+~~~
+sigrok-cli -i uart_log.sr -O binary | \
+ bin2tts --bits=8 --sample-rate=1000000 | \
+ tts-uart --mask=0x20 --baud-rate=115200
+~~~
+
+Live decode from a running system (decode pin 2 of the FX2 device):
+
+~~~
+sigrok-cli \
+ --driver fx2lafw --config samplerate=1000000 \
+ --time=100000s -O binary | \
+ bin2tts --bits=8 --sample-rate=1000000 --timeout 10000 | \
+ tts-uart --mask=0x20 --baud-rate=115200
+~~~