2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Go to file
2012-12-22 14:01:05 +08:00
djvulibre@01a26bed05 update djvulibre and crengine to latest release 2012-04-17 11:01:40 +08:00
frontend disable overlap dimming for page view mode in crereader 2012-12-18 12:31:55 +08:00
include rename mxcfb_update_data51 to mxcfb_update_data 2012-12-10 20:21:04 -05:00
kite New InfoMessage Concept 2012-10-02 21:03:56 -04:00
kpvcrlib minor tweak for kpvcrlib/CMakeLists.txt 2012-12-19 16:26:06 +08:00
launchpad Reimplement kpdf.sh changes from PR#348 after the PR#352 merge, and fix 2012-10-02 21:40:05 -04:00
libk2pdfopt@f31e2a8593 update k2pdfopt to version 1.6.3 2012-12-22 14:00:54 +08:00
luafilesystem@149e0fb8ec
luajit-2.0@eb6f890ebd moved luajit-2.0 and mupdf to latest version - now really 2012-11-26 14:02:14 -05:00
mupdf@05219d086a moved luajit-2.0 and mupdf to latest version - now really 2012-11-26 14:02:14 -05:00
popen-noshell Don't patch popen-noshell twice 2012-10-02 20:56:58 -04:00
resources Initial commit of picviewer. 2012-10-31 22:09:27 -04:00
test test file for djvu format 2012-06-05 15:23:58 +08:00
utils Add "-a author" option 2012-11-26 12:59:39 -05:00
.gitignore gitignore cleanup 2012-10-31 23:01:36 -04:00
.gitmodules move k2pdfopt source to a submodule libk2pdfopt 2012-11-26 21:58:32 +08:00
blitbuffer.c factored out blitting constraints check in a seperate function 2012-10-31 20:31:51 -04:00
blitbuffer.h
COPYING
cre.cpp Enable hyphenation and set status font 2012-12-20 12:45:58 +08:00
cre.h
djvu.c bugfix: destroying attr objects immediately after pthread_create 2012-11-26 22:17:27 +08:00
djvu.h
drawcontext.c
drawcontext.h
einkfb.c rename mxcfb_update_data51 to mxcfb_update_data 2012-12-10 20:21:04 -05:00
einkfb.h add kindlePaperWhite support for einkfb module 2012-10-20 03:33:27 +08:00
extr.c Cleanups to extr.c and pdfattach 2012-10-31 22:29:10 -04:00
ft.c fixed various bugs in pointer handling 2012-04-16 22:51:13 +02:00
ft.h
input.c Merge pull request #634 from houqp/ges-detect 2012-11-26 15:20:54 -08:00
input.h remove dependency on <linux/input.h> 2012-07-15 02:35:01 +08:00
koptcontext.c add screen dpi property in koptcontext 2012-11-27 20:42:59 +08:00
koptcontext.h update k2pdfopt to version 1.62 2012-11-26 22:13:43 +08:00
kpdf.sh only echo to /proc/keypad for K3 and DXG 2012-12-12 10:02:32 +08:00
kpdfview.c use koptcontext to keep dozons of parameters for k2pdfopt 2012-11-26 21:57:23 +08:00
Makefile add libk2pdfopt as a prerequisite lib for kpdfview object 2012-12-22 14:01:05 +08:00
mupdf.patch updated mupdf to latest version 2012-11-26 13:57:37 -05:00
mupdfimg.c fixed missing return values 2012-06-10 12:26:23 +02:00
mupdfimg.h
pdf.c bugfix: destroying attr objects immediately after pthread_create 2012-11-26 22:17:27 +08:00
pdf.h
pic_jpeg.c Factor out JPEG support into a module 2012-10-31 20:54:24 -04:00
pic_jpeg.h Factor out JPEG support into a module 2012-10-31 20:54:24 -04:00
pic.c update pic.c from latest code 2012-10-31 22:54:36 -04:00
pic.h Fix the leftover from the old name jpg.h 2012-10-31 22:09:48 -04:00
picviewer.lua Initial commit of picviewer. 2012-10-31 22:09:27 -04:00
reader.lua remove unnecessary framecontainer in reader.lua 2012-12-15 09:31:03 +08:00
README.md Mention SDL/SDL-devel requirement on Fedora 2012-10-31 21:15:01 -04:00
slider_watcher.c Kill a bit of cruft, explain the reasonning behind the kill/traps, and 2012-10-02 21:04:15 -04:00
util.c Get rid of the compilation warning. 2012-09-30 03:40:40 +08:00
util.h Correct the comment (the existing text was referring to a different file). 2012-09-17 20:09:06 -04:00
wtest.lua use getProvider and openDocument in reader.lua 2012-06-12 14:38:52 +08:00

KindlePDFViewer

This is a PDF viewer application, created for usage on the Kindle e-ink reader. It currently supports Kindle 2, DXG, 3 and 4, but not Touch. It's using the muPDF library (see http://mupdf.com/), djvulibre library, CREngine library 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:

  • fetch thirdparty sources

    • manually fetch all the thirdparty sources:

      • install muPDF sources into subfolder "mupdf"
      • install muPDF third-party sources (see muPDF homepage) into a new subfolder "mupdf/thirdparty"
      • install libDjvuLibre sources into subfolder "djvulibre"
      • install CREngine sources into subfolder "kpvcrlib/crengine"
      • install LuaJit sources into subfolder "luajit-2.0"
      • install popen_noshell sources into subfolder "popen-noshell"
    • automatically fetch thirdparty sources with Makefile:

      • make sure you have patch, wget, unzip, git and svn installed
      • run make fetchthirdparty.
  • adapt Makefile to your needs

  • run make thirdparty. This will build MuPDF (plus the libraries it depends on), libDjvuLibre, CREngine 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, or any directory 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.

If you are using Fedora Core Linux, do yum install SDL SDL-devel. If you are using Ubuntu, install libsdl-dev1.2 package.

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

And run the emulator like this:

./reader.lua /PATH/TO/PDF.pdf

or:

./reader.lua /ANY/PATH

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