From 8fa7bdb9e93079a032e82c6728fe55a01817fd9a Mon Sep 17 00:00:00 2001 From: HW Date: Wed, 16 Nov 2011 23:51:55 +0100 Subject: [PATCH] reflect recent changes in README --- README.TXT | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.TXT b/README.TXT index 5647158e0..9a8238166 100644 --- a/README.TXT +++ b/README.TXT @@ -40,5 +40,22 @@ 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. +argument. Run reader.lua without arguments to see usage notes. + +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