I have tried to write a clearer introduction for new users and make it clearer what kind of channels are available to download. Anyway, I found the structure of the original page a little bit weird and confusing.

master
Willem Vanhulle 7 years ago
parent 2436d699ba
commit a6fb7e50ff

@ -1,62 +1,82 @@
<img align="right" src="https://github.com/koreader/koreader/raw/master/resources/koreader.png" height="256" width="256" />
Welcome to **Kindle/Kobo Open Reader (KOReader)** WIKI!
<img align="right" src="https://github.com/koreader/koreader/raw/master/resources/koreader.png" height="180" width="180" />
You can check out the latest download from the [[Download]] page, or [here](http://build.koreader.rocks/download/nightly/).
# KOReader WIKI
WIKI in other languages:
* [简体中文](wiki/KOReader维基)
[简体中文](wiki/KOReader维基)
> NOTICE: Some of the content on the WIKI might be out of date. Please help make it better by opening an issue if you find any of the instructions unclear or confusing.
_KOReader is a document viewer for E-ink devices. Supported document formats include PDF, DjVu, XPS, CBZ, FB2, PDB, TXT, HTML, RTF, CHM, EPUB, DOC, MOBI, and ZIP files. Latest Kindle and Kobo devices are supported._
## Introduction
* [[Features list]]
* [[KOReader Screenshots]]
* [Configuration](#configuration)
* [Community](#community)
KOReader is a document viewer for eink devices. The formats it supports include PDF, DjVu, XPS, CBZ, FB2, PDB, TXT, HTML, RTF, CHM, EPUB, DOC, MOBI, and ZIP files.
## Setup
KOReader is rewritten from kindlepdfviewer, which is originally built by [hawhill](http://www.mobileread.com/forums/member.php?u=86292) based on the [mupdf](http://www.mupdf.com/) source. Since then it has come a long way, based on requests and updates by hackers around the world.
First-time setup depends on the device you are using. This device separation stems from the highly device-specific tool-chains used.
There are related discussion threads on the MobileRead Forums, one of the largest English language web forums for e-book reading/publishing:
* [[Installation on Kindle devices]]
* [[Installation on Kobo devices]]
* [[Installation on PocketBook devices]]
* [KOReader Forum](http://www.mobileread.com/forums/forumdisplay.php?f=276)
## Installation
<a name="installation"/>
* [KOReader for Kindle devices](http://www.mobileread.com/forums/showthread.php?t=209276)
Read [[Changelog]] or [Known problems][issue-tracker] first. Choose the KOReader build archive appropriate for your device from the following channels:
* [KOReader for Kobo devices](http://www.mobileread.com/forums/showthread.php?t=216960)
- [daily builds](http://build.koreader.rocks/download/nightly/): generated automatically, might contain severe bugs.
- [unstable builds](https://github.com/koreader/koreader/releases): released every two months on average, having less bugs.
- [custom builds](https://github.com/koreader/koreader#building-prerequisites): build it by yourself.
* [KOReader for PocketBook devices](http://www.mobileread.com/forums/showthread.php?t=254659)
Steps to install:
* [KOReader for Android devices](http://www.mobileread.com/forums/showthread.php?t=240617)
1. Save the settings of an existing installation if necessary. (Long pressing certain menu actions will save the program's defaults automatically to a separate file `defaults.persistent.lua`.)
2. Unpack the downloaded archive in the right folder on your device to install/upgrade.
For a more thorough division for different devices please take a look at [NiLuJe's builds](http://www.mobileread.com/forums/showpost.php?p=2658945&postcount=2). Here, for instance, you will find KOReader for non-touch Kindles among others too! (weekly-ish builds, not tied to any stable/nightly tag. The device separation stems from the custom, highly device-specific toolchains used).
## Configuration
<a name="configuration"/>
## For Users
After starting up KOReader, all you need to do is navigate the file manager to a library folder and set it as default by long-pressing the file name. Touch gestures are explained in [[KOReader Gestures]]. The program is loaded with useful features and settings that can be adjusted to your needs:
**Overview:**
* [[Features list]]
* [[KOReader Screenshots]]
**Getting started:**
* [[Installation on Kindle devices]]
* [[Installation on Kobo devices]]
* [[Installation on PocketBook devices]]
* [[KOReader Gestures]]
### Features
* [[Dictionary support]]
* [[Wikipedia support]]
* [[OPDS support]]
* [[Troubleshooting]]
**Plugins:**
### Plugins
* [[Calibre wireless connection]]
* [[Evernote export]]
* [[Progress sync]]
* [[Zsync transport]]
* [[Statistics plugin]]
**Advanced:**
### Advanced
* [[Tips and Tricks]]
* [[Change defaults]]
* [[Reflowing tweaks]]
## For Developers
## Development community
<a name="community"/>
KOReader is rewrite of "kindlepdfviewer", which is originally built by [hawhill](http://www.mobileread.com/forums/member.php?u=86292) based on the [mupdf](http://www.mupdf.com/) source. Since then it has come a long way, based on requests and updates by hackers around the world. The name "KOReader stands for Kindle/Kobo Open Reader, the devices for which KOReader orginally was written.
> Some of the content on the WIKI might be out of date. You are welcome to make it better by opening an issue if you find any of the instructions unclear or confusing.
### Users
You can open new issues on [Known problems][issue-tracker]. There are related discussion threads on the MobileRead Forums, one of the largest English language web forums for e-book reading/publishing:
* [KOReader Forum](http://www.mobileread.com/forums/forumdisplay.php?f=276)
* [KOReader for Kindle devices](http://www.mobileread.com/forums/showthread.php?t=209276)
* [KOReader for Kobo devices](http://www.mobileread.com/forums/showthread.php?t=216960)
* [KOReader for PocketBook devices](http://www.mobileread.com/forums/showthread.php?t=254659)
* [KOReader for Android devices](http://www.mobileread.com/forums/showthread.php?t=240617)
* [mailing list](https://www.freelists.org/list/koreader)
### Hackers
Contribute by writing code.
* [[How to Start|Development-Guide]]
* [Coding Style][coding_style]
@ -66,14 +86,7 @@ For a more thorough division for different devices please take a look at [NiLuJe
* [Remote debugging with gdbserver](https://github.com/koreader/koreader-base/wiki/Remote-debugging-with-gdbserver)
* [How to port KOReader to other platform][porting]
## Known problems
See our [issue tracker][issue-tracker].
## Mailing list
Join the KOReader [mailing list](https://www.freelists.org/list/koreader).
## Changelog
* [[Changelog]]
[coding_style]:https://github.com/koreader/koreader-base/wiki/Coding-style
[nightly build script]:https://gist.github.com/4002028

Loading…
Cancel
Save