Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cloudsftp committed Jul 23, 2023
1 parent abf37fa commit 96b7af1
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ reMarkable screenshots over ssh.
[Tutorial](https://remarkablewiki.com/tech/ssh) <br>
(recommended: SSH-key so you don't have to type in your root password every time)

- The following programs are required on your reMarkable:
- `lz4`

- The following programs are required on your computer:
- `lz4`
- `ffmpeg`
- `feh`

### Installing Programs on your reMarkable
### Recommended

It is recommended to install `lz4` on both your computer and the reMarkable tablet.

#### Installing Programs on your reMarkable

Please use [toltec](https://github.com/toltec-dev/toltec) to install `lz4` on your reMarkable.

Expand All @@ -33,11 +33,13 @@ Note: before installing the packages, run
opkg update
opkg upgrade
```
once and the install the packages via
once and then install the packages via
```
opkg install <pkg>
```

Remember to run `toltecctl reenable` on your reMarkable tablet after each software update.

## Usage

1. Connect your reMarkable via USB
Expand Down
6 changes: 5 additions & 1 deletion reSnap.sh
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,11 @@ if ssh_cmd "[ -f /opt/bin/lz4 ]"; then
elif ssh_cmd "[ -f ~/lz4 ]"; then # backwards compatibility
compress="\$HOME/lz4"
else
echo "WARNING: lz4 not found on $rm_version. Please refer to the README"
echo
echo "WARNING: lz4 not found on $rm_version."
echo " It is recommended to install it for vastly improved performance."
echo " Please refer to the README"
echo
compress="tee"
decompress="tee"
fi
Expand Down

0 comments on commit 96b7af1

Please sign in to comment.