2
0
mirror of https://github.com/koreader/koreader synced 2024-11-10 01:10:34 +00:00
Go to file
Qingping Hou 936ce2d661 fix: bug in paintRect
When calculating index of byte for rightmost column,
it should be (x + w)/2 not (x + w + 1)/2.
2012-03-06 11:10:20 +08:00
include included Linux kernel API header file for eink display 2011-11-16 15:59:37 +01:00
launchpad improved filechooser; enable "single file" mode of kindlepdfviewer 2012-03-04 23:03:04 +01:00
.gitignore Merge remote-tracking branch 'hwhw/master' into djvu 2012-03-05 23:36:58 +01:00
alt_getopt.lua better argument parsing and option for gamma correction 2011-11-16 17:13:08 +01:00
blitbuffer.c fix: bug in paintRect 2012-03-06 11:10:20 +08:00
blitbuffer.h refactored code a bit to avoid duplication 2011-12-02 22:28:48 +01:00
COPYING initial project, basic reader working 2011-11-14 18:30:16 +01:00
djvu.c fix closeDocument return #34 2012-03-05 18:37:06 +01:00
djvu.h mod: fix typo in comments 2012-03-05 10:02:39 +08:00
djvureader.lua mod: code cleanup for readers 2012-03-05 09:58:19 +08:00
einkfb.c reworked screen update emulation to support ranges 2011-12-08 23:43:37 +01:00
einkfb.h moved blitting over to blitbuffer API 2011-12-02 01:31:13 +01:00
filechooser.lua Merge remote-tracking branch 'hwhw/master' into djvu 2012-03-05 23:36:58 +01:00
filesearcher.lua mod: merge djvu branch with master 2012-03-05 09:46:16 +08:00
fontchooser.lua mod: fontchooser and pdfreader code clean up 2012-02-26 10:42:04 +08:00
ft.c restructured glyph blitting a bit and fixed bug 2011-12-08 00:39:40 +01:00
ft.h added freetype text rendering (still buggy) 2011-12-01 01:35:53 +01:00
graphics.lua major overhaul of the code structure, more OO like 2011-12-08 00:45:39 +01:00
input.c fixed included headers 2011-12-08 00:41:17 +01:00
input.h changed/enabled reader device emulation 2011-11-16 23:50:00 +01:00
inputbox.lua mod: handle shift and alt key events in adjustKeyEvents() 2012-03-02 18:38:34 +08:00
keys.lua exit reader on HOME key 2012-03-04 13:06:35 +01:00
kpdfview.c integrate djvu support 2012-03-04 23:30:08 +01:00
Makefile Merge remote-tracking branch 'hwhw/master' into djvu 2012-03-05 23:36:58 +01:00
pdf.c fix closeDocument return #34 2012-03-05 18:37:06 +01:00
pdf.h initial project, basic reader working 2011-11-14 18:30:16 +01:00
pdfreader.lua mod: code cleanup for readers 2012-03-05 09:58:19 +08:00
reader.lua Merge remote-tracking branch 'hwhw/master' into djvu 2012-03-05 23:36:58 +01:00
README.TXT example for Kindle 3 resolution emulator 2012-01-19 18:26:24 +01:00
rendertext_example.lua file mode fixes, added shebang to rendertext example script 2011-12-08 01:25:42 +01:00
rendertext.lua major overhaul of the code structure, more OO like 2011-12-08 00:45:39 +01:00
selectmenu.lua mod: handle shift and alt key events in adjustKeyEvents() 2012-03-02 18:38:34 +08:00
settings.lua added simple serializer, use lua instead of SQLite 2012-03-04 17:29:19 +01:00
unireader.lua Merge pull request #36 from traycold/master 2012-03-05 15:16:53 -08:00
util.c added freetype text rendering (still buggy) 2011-12-01 01:35:53 +01: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