Updated for the latest firmware & Rewritten to be more beginner-friendly

master
Gabriella Lee 4 years ago
parent a52263cb13
commit f7f7cb4cf9

@ -1,28 +1,53 @@
## General
## Finding your IP and password
When connected to WiFi you can find the IP address and root password for your
reMarkable in Settings -> About, then scroll down the GPLv3 compliance on the
right (finger drag scroll, not the page forward/back buttons). This should also
work for the USB network you get if you connect the reMarkable to your computer
with a USB cable.
1. Connect your device via USB or connect to a Wi-Fi network
2. Navigate to "Menu > Settings > Help > Copyright and Licenses"
3. Under "GPLv3 Compliance" you will find your username, your password and your IP:
## Install
IP (USB): 10.11.99.1 (by default)\
IP (Wi-Fi): 192.168.0.# (where # is a number assigned in your local network)
- Download and install the latest [release](https://github.com/koreader/koreader/releases) of KOReader.
## Installation via Secure Shell (SSH)
0. Windows users will need to install/enable the OpenSSH client. Mac OS and Linux users need no extra software.
1. Download the latest [release](https://github.com/koreader/koreader/releases) of KOReader.
2. Open your terminal/command line application and transfer the zip file to the "/home/root" folder on your device:
`scp koreader-remarkable-*.zip root@10.11.99.1:`\
or\
`scp koreader-remarkable-*.zip root@192.168.0.#:`
3. Log into your device and unzip the file:
```
scp koreader-remarkable-*.zip root@IP:
ssh root@IP
ssh root@yourIP
unzip koreader-remarkable-*.zip
```
- Set up to launch from long press on middle button:
4. Copy the service file to the system directory and reload all units:
```
cp -v koreader/*.service /etc/systemd/system/
cp -v koreader/koreader.service /etc/systemd/system/
systemctl daemon-reload
```
5. Launch KOReader:
`systemctl start koreader`
## Launch with middle button
1. Copy and enable the button-listen service file:
```
cp -v koreader/button-listen.service /etc/systemd/system/
systemctl enable --now button-listen
```
Some reMarkable software updates will wipe the new systemd units so you will have
to run these two steps again when that happens.
- Or you could set up to launch via swipe gesture that triggers the Draft launcher.
2. Reboot your device
3. Hold down the middle button for 3 seconds to start koreader.\
To return to xochitl just exit koreader (swipe down from the top of the screen > Tap on the top right icon > Exit > Exit).
**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 via Draft Launcher
You can also launch KOReader via the swipe gesture that triggers the Draft launcher.
1. Install reMarkable [touchgestures](https://github.com/ddvk/remarkable-touchgestures)
2. Install reMarkable [autoinstall](https://github.com/ddvk/remarkable-autoinstall)
3. Create a draft launcher entry in the /home/root/.config/draft subdirectory; create a file called eg 05-koreader (the number determines
@ -33,15 +58,8 @@ with a USB cable.
call=/home/root/koreader/koreader.sh
term=:
```
If you upgrade reMarkable to a new version of its software the touchgesture module must be installed again. The other parts of the
installation will still work.
## Launch with middle button
Hold down the middle button for 3 seconds to start koreader. To return to
xochitl just exit koreader (swipe down from the top of the screen, select icon
in the top right, Exit, Exit).
If you upgrade reMarkable to a new version of its software the touchgesture module must be installed again. The other parts of the installation will still work.
## Launch with upwards swipe
Press two fingers against the screen 10-12 cm apart to activate the touchgesture module, then swipe up with one finger from bottom of screen. The draft launcher menu should now appear. You can start koreader or any other app configured to appear in the draft menu. To return to draft launcher just exit koreader (swipe down from the top of the screen, select icon in the top right, Exit, Exit). To return to xochitl from the draft launcher menu swipe up from the bottom of the screen.
4. Press two fingers against the screen 10-12 cm apart to activate the touchgesture module, then swipe up with one finger from bottom of screen. The draft launcher menu should now appear. You can start koreader or any other app configured to appear in the draft menu. To return to draft launcher just exit koreader (swipe down from the top of the screen, select icon in the top right, Exit, Exit). To return to xochitl from the draft launcher menu swipe up from the bottom of the screen.

Loading…
Cancel
Save