2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Go to file
Dobrica Pavlinusic 5d9176907f show_overlap inverts part of page visible in previous view
This is nice feature of Sony e-book readers which is very useful when
reading since it shows previous part of visible page and provides
hint where to continue reading after page refresh
2012-04-09 16:36:22 +02:00
djvulibre@6c9aae4bac move third-party git checkouts into submodules #43 2012-03-07 17:19:52 +01:00
include included Linux kernel API header file for eink display 2011-11-16 15:59:37 +01:00
kpvcrlib mod: small changes for kindle build 2012-04-04 15:27:01 +08:00
launchpad removed obsolete Shift-P-P combination 2012-04-09 12:30:56 +02:00
luafilesystem@149e0fb8ec move third-party git checkouts into submodules #43 2012-03-07 17:19:52 +01:00
mupdf@e7bb1c4937 fix: push mupdf commit to e7bb1c4937593c95065dbbbdd7eb15a73996c470 2012-03-08 19:45:16 +08:00
test test pdf file for two-column zoom #69 2012-03-26 21:28:14 +02:00
.gitignore add: patch files for previous commit 2012-04-04 03:00:20 +08:00
.gitmodules mod: use customed cmake rules to build CREngine libraries 2012-04-02 11:52:34 +08:00
alt_getopt.lua better argument parsing and option for gamma correction 2011-11-16 17:13:08 +01:00
blitbuffer.c Merge branch 'master' of github.com:hwhw/kindlepdfviewer into djvu-highlight 2012-03-20 10:36:35 +08:00
blitbuffer.h refactored code a bit to avoid duplication 2011-12-02 22:28:48 +01:00
commands.lua mod: move slider event handling to global command module 2012-04-08 12:46:33 +08:00
COPYING initial project, basic reader working 2011-11-14 18:30:16 +01:00
cre.cpp mod: use XPointer as absolute postion indicator inside document 2012-04-07 22:55:56 +08:00
cre.h add: data from crengine 2012-03-29 00:16:00 +08:00
crereader.lua show_overlap inverts part of page visible in previous view 2012-04-09 16:36:22 +02:00
djvu.c Merge branch 'master' into epub 2012-04-01 08:27:25 +08:00
djvu.h mod: fix typo in comments 2012-03-05 10:02:39 +08:00
djvureader.lua mod: prefix global variables width and height with G_ 2012-04-09 15:42:19 +08:00
drawcontext.c fix a Lua 5.0 syntax that was deprecated in 5.1 2012-03-19 19:11:32 +01:00
drawcontext.h separate DC out of pdf.c and djvu.c (cleanup) 2012-03-19 18:59:36 +01:00
einkfb.c mod: simulate full screen update in SDL emulator 2012-03-31 21:09:06 +08:00
einkfb.h moved blitting over to blitbuffer API 2011-12-02 01:31:13 +01:00
filechooser.lua fix: handle screen resolution correctly in filesearcher 2012-04-08 14:31:23 +08:00
filesearcher.lua mod: prefix global variables width and height with G_ 2012-04-09 15:42:19 +08:00
font.lua using font module for getting fonts (commit f95231d789) 2012-03-20 20:15:24 +01:00
ft.c fix a Lua 5.0 syntax that was deprecated in 5.1 2012-03-19 19:11:32 +01:00
ft.h added freetype text rendering (still buggy) 2011-12-01 01:35:53 +01:00
graphics.lua mod: fix bug in cursor move 2012-03-24 18:28:52 +08:00
helppage.lua mod: prefix global variables width and height with G_ 2012-04-09 15:42:19 +08:00
input.c switched slider handling to a fork()ed process 2012-04-09 12:29:13 +02:00
input.h changed/enabled reader device emulation 2011-11-16 23:50:00 +01:00
inputbox.lua mod: rewrite inputbox with commands 2012-04-09 17:17:23 +08:00
keys.lua add: demo for fixing #85, #86 2012-04-06 13:51:37 +08:00
kpdfview.c half done demo for crengine 2012-03-29 00:09:26 +08:00
Makefile Merge pull request #94 from dpavlin/dbbd6e4c1247e4caeff79245c62f5dd352b17d5b 2012-04-09 04:30:20 -07:00
pdf.c Merge branch 'master' into epub 2012-04-01 08:27:25 +08:00
pdf.h initial project, basic reader working 2011-11-14 18:30:16 +01:00
pdfreader.lua mod: prefix global variables width and height with G_ 2012-04-09 15:42:19 +08:00
reader.lua fixed missed case for device/emu recognition 2012-04-09 16:32:19 +02:00
README.TXT example for Kindle 3 resolution emulator 2012-01-19 18:26:24 +01:00
rendertext_example.lua mod: prefix global variables width and height with G_ 2012-04-09 15:42:19 +08:00
rendertext.lua using font module for getting fonts (commit f95231d789) 2012-03-20 20:15:24 +01:00
screen.lua mod: prefix global variables width and height with G_ 2012-04-09 15:42:19 +08:00
selectmenu.lua mod: rewrite filesearcher with command module 2012-04-08 11:57:25 +08:00
settings.lua using font module for getting fonts (commit f95231d789) 2012-03-20 20:15:24 +01:00
slider_watcher.c add: demo for fixing #85, #86 2012-04-06 13:51:37 +08:00
unireader.lua show_overlap inverts part of page visible in previous view 2012-04-09 16:36:22 +02:00
util.c device recognition now fully automatic 2012-04-09 12:30:12 +02:00
util.h initial project, basic reader working 2011-11-14 18:30:16 +01:00

KindlePDFViewer
===============

This is a PDF viewer application, created for usage on the Kindle e-ink reader.
It is currently restricted to 4bpp inverse grayscale displays. It's using the
muPDF library (see http://mupdf.com/) and its UI is scripted using Lua (see
http://www.lua.org/).

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


Building
========

Follow these steps:

- install muPDF sources into subfolder "mupdf"
- install muPDF third-party sources (see muPDF homepage) into a new subfolder
  "mupdf/thirdparty"

- install Lua sources into subfolder "lua"

=> note that there's a make target to do this. You need wget, unzip and git
   installed. Then just run "make fetchthirdparty".

- adapt Makefile to your needs

- run "make thirdparty". This will build MuPDF (plus the libraries it depends
  on) and Lua.

- run "make". This will build the kpdfview application


Running
=======

The user interface (or what's there yet) is scripted in Lua. See "reader.lua".
It uses the Linux feature to run scripts by using a corresponding line at its
start.
So you might just call that script. Note that the script and the kpdfview
binary currently must be in the same directory.
You would then just call reader.lua, giving the document file path as its first
argument. Run reader.lua without arguments to see usage notes.
The reader.lua script can also show a file chooser: it will do this when you
call it with a directory (instead of a file) as first argument.


Device emulation
================

The code also features a device emulation. You need SDL headers and library
for this. It allows to develop on a standard PC and saves precious development
time. It might also compose the most unfriendly desktop PDF reader, depending
on your view.

To build in "emulation mode", you need to run make like this:
	make clean cleanthirdparty
	EMULATE_READER=1 make thirdparty kpdfview

The reader.lua script needs a device argument in order to cope with some
slight differences between actual readers and the emulation. Run it like
this:
	./reader.lua -d emu /PATH/TO/PDF.pdf

By default emulation will provide DXG resolution of 824*1200. It can be
specified at compile time, this is example for Kindle 3:

	EMULATE_READER_W=600 EMULATE_READER_H=800 EMULATE_READER=1 make kpdfview