Reorganize and reformat some of the installation documentation.

master
ranguli 9 months ago
parent e3b3dce303
commit f49cbd3fa8

@ -1,22 +1,35 @@
- For distributions based on Debian/Ubuntu:
## Debian and Ubuntu-based distros
Download the `.deb` package for your computer architecture, `x86_64` when in doubt.
Install it from your package manager or from the commandline with `apt install koreader*.deb`
Packages for Debian and Ubuntu-based distros can be obtained by heading to the [Releases](https://github.com/koreader/koreader/releases) page and finding the appropriate `.deb` for your architecture.
- For generic distributions (x86_64):
* From the [Releases](https://github.com/koreader/koreader/releases) page, find the release version you would like to download (the latest stable one is a safe choice).
* Under the **Assets** section for the release, find the `.deb` package for your architecture. It will look something like `koreader-2023.08-amd64.deb`.
* If you are in doubt about your computers architecture, choose `amd64`.
Download the `AppImage` and make it executable with `chmod +x koreader*.AppImage`
Execute it with `./koreader*.AppImage`
After downloading the `.deb` file, it can be installed either via a graphical application provided by your distro, or from the command line:
```bash
sudo apt install koreader-2023.08-amd64.deb
```
## Arch Linux
- Flathub
Third-party packages are available for Arch Linux through the Arch User Repository (AUR).
You can install from Flathub: <https://flathub.org/apps/rocks.koreader.KOReader>.
KOReader is available through the AUR as both a regular [binary package](https://aur.archlinux.org/packages/koreader-bin) called `koreader-bin`, and an [AppImage package](https://aur.archlinux.org/packages/koreader-appimage) called `koreader-appimage`.
- For Arch Linux
## Flatpak
You can install the AppImage as above, or install the third-party package from AUR: https://aur.archlinux.org/packages/koreader-appimage/ for automatic updates.
Flatpak versions of KOReader are available on [Flathub](https://flathub.org/apps/rocks.koreader.KOReader).
## So what is this “AppImage”?
## AppImage
### Installation
Download the `AppImage` and make it executable with `chmod +x koreader*.AppImage`
Execute it with `./koreader*.AppImage`
### What is an AppImage?
Simply put, it's a portable app for Linux, which has been a long-standing request (#1417). After you download the file, you'll first need to allow it to run as a program. You can do so by right clicking in your file manager, choosing `Properties``Permissions` and checking the box that reads `Allow this file to run as a program` or something equivalent. If you prefer to use the terminal, run `chmod +x koreader-appimage-x86_64-linux-gnu-v2015.11-1644-ge39ed90_2018-04-09.AppImage`.
@ -24,6 +37,10 @@ The AppImage is a release version of what we KOReader developers call “the emu
Because the AppImage is built on top of the emulator, you can set default window sizes and DPI through the command line. `EMULATE_READER_W=2000 EMULATE_READER_H=1500 EMULATE_READER_DPI=180 ./koreader-appimage-x86_64-linux-gnu-v2015.11-1644-ge39ed90_2018-04-09.AppImage`. You could also try out other debugging aids such as `EMULATE_READER_FLASH=100`. There's also another more practical use besides just reading documents: you could use the AppImage to verify whether a bug is specific to your device or if it's inherent in the program.
## Reading controls
Interaction with the KOReader GUI can be entirely handled using a mouse, and the function is the same as that of touch-native platforms. Additionally, KOReader implements [keyboard shortcuts](https://github.com/koreader/koreader/wiki/Keyboard-navigation) for navigating through pages of books, menu options, etc.

Loading…
Cancel
Save