Extend the README. master
authorrekado <rekado@elephly.net>
Tue, 5 Jul 2016 19:47:23 +0000 (21:47 +0200)
committerrekado <rekado@elephly.net>
Tue, 5 Jul 2016 19:47:23 +0000 (21:47 +0200)
README

diff --git a/README b/README
index d72bc613e619a9e25cff05ecb6829b0c6bc22a6e..2512de18af96eb4f650c8d6c48645ed98b1c90a4 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,10 @@
+This library aims to provide procedures to easily send a stream of
+bytes via the analogue audio output and decode an analogue signal
+received over the line input to a stream of bytes.
+
+The output is an amplitude-modulated 48kHz signal.  Every byte is
+split into 2-bit tuples, which are then mapped to an amplitude level.
+
 * Enter development environment with Guix
 The easiest way to create an environment in which all development
 dependencies are available is GNU Guix.  A package expression is
@@ -48,3 +55,10 @@ signal with:
 #+BEGIN_SRC sh
 ./test.sh
 #+END_SRC
+
+Print the generated test signal with
+
+#+BEGIN_SRC sh
+export GUILE_LOAD_PATH=$PWD:$GUILE_LOAD_PATH
+guile -e main -s test.scm print
+#+END_SRC