Updated Installation on ReMarkable (markdown)

master
gbyl 4 years ago
parent 3fcf6640f0
commit 2552f41ec1

@ -1,8 +1,8 @@
## Finding your IP and password ## Finding your IP and password
1. Connect your device via USB (or Wi-Fi) 1. Connect your device via USB (or Wi-Fi).
2. Navigate to "Menu > Settings > Help > Copyright and Licenses" 2. Navigate to "Menu > Settings > Help > Copyright and Licenses".
3. Under "GPLv3 Compliance" you will find your username ("root"), your password and your IP ("10.11.99.1") 3. Under "GPLv3 Compliance" you will find your username ("root"), your password and your IP ("10.11.99.1").
## Installation ## Installation
@ -39,8 +39,8 @@ systemctl enable koreader
2. Reboot your device:\ 2. Reboot your device:\
`reboot` `reboot`
3. KOReader starts automatically upon startup 3. KOReader starts automatically upon startup
- To return to xochitl simply exit KOReader or run `systemctl start xochitl` - To return to xochitl simply exit KOReader or run `systemctl start xochitl`.
- **Note:** Make sure at least one service is enabled. If both xochitl and koreader services are disabled, your device will be stuck at "reMarkable is starting" screen - **Note:** Make sure at least one service is enabled. If both xochitl and koreader are disabled, your device will become stuck at "reMarkable is starting" screen.
### Launch with middle button ### Launch with middle button
1. Copy and enable the button-listen service file: 1. Copy and enable the button-listen service file:
@ -48,18 +48,18 @@ systemctl enable koreader
cp -v koreader/button-listen.service /etc/systemd/system/ cp -v koreader/button-listen.service /etc/systemd/system/
systemctl enable --now button-listen systemctl enable --now button-listen
``` ```
2. Reboot your device 2. Reboot your device.
3. Hold down the middle button for 3 seconds to start koreader. 3. Hold down the middle button for 3 seconds to start KOReader.
- To return to xochitl simply exit KOReader. - To return to xochitl simply exit KOReader.
- **Note:** ReMarkable firmware updates will wipe KOReader's systemd units so you will have to run `cp -v koreader/*.service /etc/systemd/system/` again when that happens. - **Note:** ReMarkable firmware updates will wipe KOReader's systemd units so you will have to run `cp -v koreader/*.service /etc/systemd/system/` again when that happens.
### Launch with external launcher ### Launch with external launcher
KOReader is supported by launchers such as: [oxide](https://github.com/Eeems/oxide/releases), [draft](https://github.com/dixonary/draft-reMarkable) and [remux](https://rmkit.dev/apps/remux) KOReader is supported by launchers such as: [oxide](https://github.com/Eeems/oxide/releases), [draft](https://github.com/dixonary/draft-reMarkable) and [remux](https://rmkit.dev/apps/remux)
For example, here are the steps to launch KOReader via the swipe gesture that triggers the draft launcher. As an example, here are the steps to launch KOReader via the draft's swipe gesture:
1. Install reMarkable [touchgestures](https://github.com/ddvk/remarkable-touchgestures) 1. Install reMarkable [touchgestures](https://github.com/ddvk/remarkable-touchgestures).
2. Install reMarkable [autoinstall](https://github.com/ddvk/remarkable-autoinstall) 2. Install reMarkable [autoinstall](https://github.com/ddvk/remarkable-autoinstall).
3. Create a draft launcher entry in the `/home/root/.config/draft` subdirectory and within it create a file called `eg 05-koreader` (the number determines where the entry appears in the menu sort order). 3. Create a draft launcher entry in the `/home/root/.config/draft` subdirectory and within it create a file called `eg 05-koreader` (the number determines where the entry appears in the menu sort order)
``` ```
name=koreader name=koreader
desc=EBook reader desc=EBook reader

Loading…
Cancel
Save