2
0
mirror of https://github.com/koreader/koreader synced 2024-11-18 03:25:46 +00:00
Go to file
Dobrica Pavlinusic d8a58e8764 revert 70b7e029d3
It's not that simple since ZOOM_FIT_TO_CONTENT_HALF_WIDTH also
needs bounding boxes, and this seems like over-optimization
which seems to be bug infested especially because it deals
with negative numbers so code just *looks* wrong
2012-03-12 00:42:44 +01: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
launchpad fix: add double quotes 2012-03-08 19:29:30 +08: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
.gitignore fix fetchthirdparty, closes #43 2012-03-08 14:06:16 +01:00
.gitmodules move third-party git checkouts into submodules #43 2012-03-07 17:19:52 +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: adjust page number in toc 2012-03-11 09:44:05 +08: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 mod: screen rotation implemented by ioctl 2012-03-09 18:34:56 +08:00
einkfb.h moved blitting over to blitbuffer API 2011-12-02 01:31:13 +01:00
filechooser.lua add: status bar in reading menu & font.lua 2012-03-10 16:41:23 +08:00
filesearcher.lua add: status bar in reading menu & font.lua 2012-03-10 16:41:23 +08:00
font.lua add: status bar in reading menu & font.lua 2012-03-10 16:41:23 +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 add: status bar in reading menu & font.lua 2012-03-10 16:41:23 +08: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: clean up in inputbox.lua 2012-03-11 15:46:25 +08:00
keys.lua mod: screen rotation implemented by ioctl 2012-03-09 18:34:56 +08:00
kpdfview.c integrate djvu support 2012-03-04 23:30:08 +01:00
Makefile fix fetchthirdparty, closes #43 2012-03-08 14:06:16 +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 add: status bar in reading menu & font.lua 2012-03-10 16:41:23 +08: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 renderUtf8Text shouldn't die witout a text 2012-03-06 12:32:15 +01:00
screen.lua add: status bar in reading menu & font.lua 2012-03-10 16:41:23 +08:00
selectmenu.lua fix typo 2012-03-10 14:09:12 +01:00
settings.lua added simple dump() serializer for debugging 2012-03-06 23:17:37 +01:00
unireader.lua revert 70b7e029d3 2012-03-12 00:42:44 +01: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