Wording tweaks and reordering

master
gbyl 3 years ago
parent 4308d3cbb2
commit cb2a179d2d

@ -11,29 +11,22 @@ ssh root@10.11.99.1
## Installing
### Installation via Toltec
1. SSH into your device and install [toltec](https://github.com/toltec-dev/toltec#install-it)
2. For reMarkable 1:
```
opkg install koreader
```
3. For reMarkable 2:
```
opkg install rm2fb koreader
```
4. Edit the default service file to be toltec-compatible:
```
sed -i "s|/home/root/koreader/koreader.sh|/opt/bin/koreader|g" /opt/koreader/koreader.service
```
5. Copy the service file to the system directory:
1. SSH into your device and install [Toltec](https://github.com/toltec-dev/toltec#install-it)
2.
- For reMarkable 1: `opkg install koreader`
- For reMarkable 2: `opkg install rm2fb koreader`
3. Edit the default service file and copy it to the system directory by running:
```
cp -v /opt/koreader/koreader.service /etc/systemd/system/
sed "s|/home/root/koreader/koreader.sh|/opt/bin/koreader|g" /opt/koreader/koreader.service > /etc/systemd/system/koreader.service
```
6. Launch KOReader:
4. Launch KOReader:
```
systemctl start koreader
```
- **Note:** Check for updates from within KOReader as toltec may not have yet indexed the latest release.
- **Note:** reMarkable firmware updates will delete KOReader's systemd units. Run `toltecctl reenable` and repeat steps 4 and 5 after every firmware update
- Check for updates from within KOReader as Toltec may not have yet indexed the latest release
- To return to Xochitl simply exit KOReader
- reMarkable firmware updates will delete KOReader's systemd units. Run `toltecctl reenable` and step 3 after every firmware update
### Manual installation
1. Download the [latest release](https://github.com/koreader/koreader/releases) of KOReader
@ -62,38 +55,38 @@ systemctl start koreader
## Launching
### Automatic launch
**Warning:** Make sure KOReader starts successfully before configuring the automatic launch. If both `xochitl` and `koreader` are disabled, your device will be stuck at "reMarkable is starting". Keep a copy of your password in case you need to troubleshoot.
1. SSH into your device and run:
**Warning:** Make sure `systemctl start koreader` works before proceeding!
To launch KOReader at startup, SSH into your device and run:
```
systemctl disable xochitl
systemctl enable koreader
systemctl disable xochitl
reboot
```
2. Reboot your device
- To return to Xochitl simply exit KOReader
### Launch with external launcher
### External launcher
KOReader is supported by the following launchers: [oxide](https://github.com/Eeems/oxide), [draft](https://github.com/dixonary/draft-reMarkable) and [remux](https://rmkit.dev/apps/remux). They can installed via [toltec](https://github.com/toltec-dev/toltec#install-it) e.g. `opkg install oxide`.
KOReader can be launched by: [oxide](https://github.com/Eeems/oxide), [draft](https://github.com/dixonary/draft-reMarkable) and [remux](https://rmkit.dev/apps/remux). They can installed via [toltec](https://github.com/toltec-dev/toltec#install-it), for example:
```
opkg install oxide
```
### Launch with middle button
1. SSH into your device and run:
### Middle button launch
To launch KOReader by holding down the middle button for 3 seconds, SSH into your device and run:
```
cp -v /opt/koreader/button-listen.service /etc/systemd/system/
systemctl enable --now button-listen
reboot
```
2. Reboot your device
3. While using Xochitl, hold down the middle button for 3 seconds to start KOReader
## Optional
### Override System Splashscreens
To use KOReader's screensaver feature for poweroff and reboot events:
1. SSH into your device and run:
To use KOReader's screensaver feature for poweroff and reboot events, SSH into your device and run:
```
systemctl disable remarkable-shutdown
systemctl disable remarkable-reboot
```
2. Reboot your device
reboot
```
Loading…
Cancel
Save