diff options
Diffstat (limited to 'README.org')
-rw-r--r-- | README.org | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/README.org b/README.org new file mode 100644 index 0000000..99842e5 --- /dev/null +++ b/README.org @@ -0,0 +1,16 @@ +#+title: Inkplate Display +#+options: toc:nil + +My script for displaying information on my Inkplate. + +* Requirements + +This script needs [[https://www.gnu.org/software/guile/][Guile]] and [[https://git.sr.ht/~ryuslash/guile-inkplate][guile-inkplate]]. + +* Installation + +Put the =inkplate-display= script anywhere in your =$PATH=. + +* Usage + +Run the =inkplate-display= script without any arguments. This script assumes that your Inkplate is connected, running in peripheral mode, and that the file descriptor is located at =/dev/ttyUSB0=. |