mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00

Go to file

chrox 82cb20e448 update koreader-base		2013-12-01 21:22:23 +08:00
extensions/koreader	Minor startup script tweaks.	2013-09-29 21:54:23 +02:00
fmon	Safer installing process for Kobos	2013-09-30 23:03:39 +02:00
frontend	add detection of more 3G Paperwhite 2 models	2013-12-01 21:06:33 +08:00
koreader-base@ff2c9a2b02	update koreader-base	2013-12-01 21:22:23 +08:00
l10n	force download po files	2013-11-29 22:46:39 +08:00
launchpad	adapted wrapper script and launcher configurations	2013-03-24 17:28:32 +01:00
resources	rescale font size when fallbacks to fallback fonts	2013-10-16 12:22:53 +08:00
test	test file for djvu format	2012-06-05 15:23:58 +08:00
.gitignore	update gitignore file to ignore files in test directory	2013-04-30 13:44:37 +08:00
.gitmodules	changed submodule koreader-base to its new URI	2013-03-24 19:31:10 +01:00
COPYING	initial project, basic reader working	2011-11-14 18:30:16 +01:00
defaults.lua	set auto detect word gap in reflowing by default	2013-10-24 23:45:09 +08:00
kobo_suspend.sh	Split suspend-resume logic	2013-09-09 12:30:27 +02:00
koreader_kobo.sh	Don't kill nickel software, it's not really needed and might prevent issues with database corruption.	2013-08-17 13:18:23 +02:00
koreader.sh	Minor startup script tweaks.	2013-09-29 21:54:23 +02:00
Makefile	update po file from transifex automatically on each build	2013-11-29 22:41:56 +08:00
reader.lua	remove global variable DEBUG	2013-10-25 20:09:21 +08:00
README.md	update readmes	2013-09-26 01:06:10 -04:00
wtest.lua	update keyboard widget test in wtest	2013-07-30 23:08:10 +08:00

README.md

KOReader

This is a document viewer application, originally created for usage on the Kindle e-ink reader. It currently supports Kindle 5 (Touch), Kindle Paperwhite and Kobo devices. Kindles 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 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 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 at its fork Librerator.

The application is licensed under the GPLv3 (see COPYING file).

Prerequisites

Instructions about how to get and compile the source are intended for a *nix OS. Windows users are suggested to develop in a Linux VM or use andLinux, Wubi.

To get and compile the source you must have patch, wget, unzip, git, svn, autoconf and cmake installed.

Version of autoconf need to be greater than 2.64.

You might also need SDL library packages if you want to compile and run the PC emulator. Fedora users can install SDL and SDL-devel. Ubuntu users can install libsdl1.2-dev.

Getting the source

git clone https://github.com/koreader/koreader.git
cd koreader
make fetchthirdparty

Building & Running

For real eink devices

If you already done an emulator build, you must do:

make clean

To build for the Kindle:

make customupdate

To build for the Kobo:

make TARGET_DEVICE=KOBO koboupdate

To run, you must call the script reader.lua. Run it without arguments to see usage notes. Note that the script and the koreader-base binary currently must be in the same directory.

You may checkout our nightlybuild script to see how to build a package from scratch.

For emulating

If you already done a real device build, you must do:

make clean

To build

EMULATE_READER=1 make

To run:

cd koreader-*/koreader && ./reader.lua -d ./

You can also specify size of emulator's screen via environment variables. For more information, please refer to koreader-base's README.

Use ccache

Ccache can speed up recompilation by caching previous compilations and detecting when the same compilation is being done again. In other words, it will decrease build time when the source have been built. Ccache support has been added to KOReader's build system. Before using it, you need to install a ccache in your system.

in ubuntu use:sudo apt-get install ccache
in fedora use:sudo yum install ccache
install from source:
- get latest ccache source from http://ccache.samba.org/download.html
- unarchieve the source package in a directory
- cd to that directory and use:./configure && make && sudo make install
after using ccache, make a clean build will only take 15sec. Enjoy!
to disable ccache, use export USE_NO_CCACHE=1 before make.
for more detail about ccache. visit:

http://ccache.samba.org