renun/koreader
1
0
Fork 0
mirror of https://github.com/koreader/koreader.git synced 2025-08-10 00:52:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Qingping Hou
2012-09-17 00:27:54 +08:00
parent ea325146d3
commit 1b3e1db0d2
1 changed files with 24 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
README.TXT
View File

@@ -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: