From 48ce1ba15723ddb3807ee681729d330d3972a155 Mon Sep 17 00:00:00 2001
From: Tom Willemse
Date: Fri, 7 Jul 2023 23:12:47 -0700
Subject: Add ‘--reset’ command-line option

Passing this option will cause a full update command to be sent to the Inkplate
instead of a partial update command.

A full update cleans up any residual display from previous partial updates, but
causes more wear on the eink display. It causes a big flash of all black to
happen before sending the updated display. I shouldn't be used all the time.
---
 README.org | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'README.org')

diff --git a/README.org b/README.org
index 99842e5..1a29b8d 100644
--- a/README.org
+++ b/README.org
@@ -14,3 +14,7 @@ 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=.
+
+The following command-line arguments are available:
+
+- =--reset= :: Causes a full screen update to be sent to the Inkplate instead of a partial one. Clears any artifacts from previous partial updates, but is harder on the display so shouldn't be used all the time.
-- 
cgit v1.2.3-54-g00ecf