summaryrefslogtreecommitdiff
path: root/academic/sigrok-cli/README
diff options
context:
space:
mode:
Diffstat (limited to 'academic/sigrok-cli/README')
-rw-r--r--academic/sigrok-cli/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/academic/sigrok-cli/README b/academic/sigrok-cli/README
new file mode 100644
index 0000000000..4379219c19
--- /dev/null
+++ b/academic/sigrok-cli/README
@@ -0,0 +1,9 @@
+sigrok-cli is a cross-platform command line utility for the sigrok software.
+
+It cannot display graphical output, but is still sufficient to run
+through the whole process of hardware initialization, acquisition,
+protocol decoding and saving the session.
+
+It is useful for running on remote or embedded systems, netbooks, PDAs,
+and for various other use-cases. It can display samples on standard
+output or save them in various file formats.