mirror of
https://github.com/koreader/koreader.git
synced 2025-08-10 00:52:38 +00:00
capitalize KOR to make it less like korea ;p
This commit is contained in:
14
README.md
14
README.md
@@ -1,4 +1,4 @@
|
||||
Koreader
|
||||
KOReader
|
||||
========
|
||||
|
||||
This is a document viewer application, created for usage on the Kindle e-ink reader.
|
||||
@@ -6,11 +6,11 @@ It currently supports Kindle 5 (Touch) and Kindle Paperwhite. The devices need
|
||||
to be jailbroken in order to install the application. Also, a kind of external
|
||||
launcher is needed.
|
||||
|
||||
Koreader started as the KindlePDFViewer application, but it supports much more
|
||||
KOReader started as the KindlePDFViewer application, but it supports much more
|
||||
formats than PDF now. Among them are DJVU, FB2, EPUB, TXT, CBZ, HTML.
|
||||
|
||||
Koreader is a frontend written in Lua and uses the API presented by the
|
||||
Koreader-base framework. Koreader implements a GUI and is currently targeted
|
||||
KOReader is a frontend written in Lua and uses the API presented by the
|
||||
KOReader-base framework. KOReader implements a GUI and is currently targeted
|
||||
at Touch-based devices - for the classic user interface for button-driven
|
||||
e-ink devices (like the Kindle 2, Kindle DX, Kindle 3, Kindle 4) see the
|
||||
KindlePDFviewer legacy project or - especially for the Kindle 4 - have a look
|
||||
@@ -47,7 +47,7 @@ Follow these steps:
|
||||
* run `make thirdparty`. This will build MuPDF (plus the libraries it depends
|
||||
on), libDjvuLibre, CREngine, libk2pdfopt and Lua.
|
||||
|
||||
* run `make`. This will build the koreader application (see below if you want
|
||||
* run `make`. This will build the KOReader application (see below if you want
|
||||
to build in emulation mode so you can test it on PC)
|
||||
|
||||
|
||||
@@ -71,8 +71,8 @@ this when you call it with a directory (instead of a file) as first argument.
|
||||
|
||||
In emulator
|
||||
-----------
|
||||
You need to first compile koreader-base in emulation mode.
|
||||
* If you have built koreader in real mode before, you need to clean it up:
|
||||
You need to first compile KOReader-base in emulation mode.
|
||||
* If you have built KOReader in real mode before, you need to clean it up:
|
||||
|
||||
```
|
||||
make clean && make cleanthirdparty
|
||||
|
||||
Reference in New Issue
Block a user