Better documentation

reStream.sh

@@ -1,34 +1,64 @@
 #!/bin/sh
-ssh_host="root@10.11.99.1"
-landscape=true
 
+# these are probably the only two parameters you need to change
+ssh_host="root@10.11.99.1" # location of the remarkable
+landscape=true             # set to false if you want it horizontal
+
+# technical parameters
 width=1408
 height=1872
 bytes_per_pixel=2
 loop_wait="true"
 loglevel="info"
 
+# check if we are able to reach the remarkabl
 if ! ssh "$ssh_host" true; then
     echo "$ssh_host unreachable"
     exit 1
 fi
 
-# Gracefully degrade to gzip if zstd is not present
-if which zstd && ssh "$ssh_host" "[ -f /opt/bin/zstd ]"; then
-    compress="/opt/bin/zstd"
-    decompress="zstd -d"
-else
+fallback_to_gzip() {
+    echo "Falling back to gzip, your experience may not be optimal."
+    echo "Go to https://github.com/rien/reStream/#sub-second-latency for a better experience."
     compress="gzip"
     decompress="gzip -d"
+    sleep 2
+}
+
+# check if zstd is present on remarkable
+if ssh "$ssh_host" "[ -f /opt/bin/zstd ]"; then
+    compress="/opt/bin/zstd"
+elif ssh "$ssh_host" "[ -f /home/root/zstd ]"; then
+    compress="/home/root/zstd"
+fi
+
+# gracefully degrade to gzip if zstd is not present on remarkable or host
+if [ -z "$compress" ]; then
+    echo "Your remarkable does not have zstd."
+    fallback_to_gzip
+elif ! which zstd; then
+    echo "Your host does not have zstd."
+    fallback_to_gzip
+else
+    decompress="zstd -d"
 fi
 
 
+
+
+# calculte how much bytes the window is
 window_bytes="$(($width*$height*$bytes_per_pixel))"
+
+# rotate 90 degrees if landscape=true
 landscape_param="$($landscape && echo '-vf transpose=1')"
+
+# read the first $window_bytes of the framebuffer
 head_fb0="dd if=/dev/fb0 count=1 bs=$window_bytes 2>/dev/null"
+
+# loop that keeps on reading and compressing, to be executed remotely
 read_loop="while $head_fb0; do $loop_wait; done | $compress"
 
-set -e
+set -e # stop if an error occurs
 
 ssh  "$ssh_host" "$read_loop" \
     | $decompress \