Further ctrl-1/2 tweaks
[llpp/slowscroll.git] / BUILDING
blob6254f61eea184d9760405533d2bf0a4a860ef415
1 MuPDF[1] rendering library is used to do the actual work, so it needs
2 to be built and installed to use llpp, MuPDF's README[2] describes how
3 to build it and lists its dependencies. Snapshots of MuPDF itself can
4 be found here[3]
6 Note that MuPDF is a moving target therefore bellow is the commit id
7 of the git version of MuPDF that this version of llpp is known to work
8 with:
9 1b4b5fdfa6b74827631d42efd2a61226125f036b
11 llpp also depends on OCaml[4], lablGL[5], having a C compiler wouldn't
12 hurt either.
14 To build llpp "the easy way" one can invoke `sh buildall.sh' which
15 will first attempt to automatically fetch lablGL, mupdf, mupdf's
16 prerequisites and build them, then, if everything goes fine, it will
17 proceed building llpp itself. Note that OCaml still needs to be
18 installed separately, also, in addition to the usual suspects (i.e.
19 GCC, make, binutils, OCaml), you will need `wget' and `unzip' for this
20 script to work.
22 Otherwise, provided that all prereqs are already built, one should
23 invoke `sh build.sh' from the top of llpp's directory, prior to that
24 it's advisable to review build.sh so that it matches local mupdf
25 installation (or lack thereof)
27 If everything goes fine llpp binary will appear, it can be used like so:
29 $ ./llpp /path/to/some.pdf
31 $ ./llpp -p password /path/to/some.password.protected.pdf
33 [1] http://www.mupdf.com
34 [2] http://mupdf.com/repos/mupdf/README
35 [3] http://mupdf.com/download/snapshots/
36 [4] http://caml.inria.fr/
37 [5] http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/lablgl.html