From 1b3e1db0d21794b5c60a594f423bdb3e92dbd557 Mon Sep 17 00:00:00 2001 From: Qingping Hou Date: Mon, 17 Sep 2012 00:27:54 +0800 Subject: [PATCH] update readme --- README.TXT | 40 ++++++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/README.TXT b/README.TXT index f05e506f8..a365d46c2 100644 --- a/README.TXT +++ b/README.TXT @@ -12,24 +12,26 @@ 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" +- 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 libDjvuLibre sources into subfolder "djvulibre" -- install CREngine sources into subfolder "kpvcrlib/crengine" - -- install LuaJit sources into subfolder "luajit-2.0" - -=> note that there's a make target to do all the above. You need wget, unzip and git - installed. Then just run "make fetchthirdparty". + - automatically fetch thirdparty sources with Makefile: + - make sure you have wget, unzip and git installed + - run "make fetchthirdparty". - adapt Makefile to your needs - run "make thirdparty". This will build MuPDF (plus the libraries it depends - on) and Lua. + on), libDjvuLibre, CREngine and Lua. - run "make". This will build the kpdfview application @@ -40,12 +42,14 @@ 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. + +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 @@ -54,7 +58,9 @@ 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. +on your view. + +If you are using Ubuntu, simply install `libsdl-dev1.2` package. To build in "emulation mode", you need to run make like this: make clean cleanthirdparty @@ -62,6 +68,8 @@ To build in "emulation mode", you need to run make like this: 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: