Ubuntu CI: make apt update before apt install
[llpp.git] / BUILDING
blob8ba4928eaf6eb14a4419c5d33f90f7b47b150e68
1 Prerequisites for building from sources:
2     bash          [https://en.wikipedia.org/wiki/Bash_(Unix_shell)]
3     mupdf         [https://mupdf.com]
4     opengl        [https://en.wikipedia.org/wiki/OpenGL]
5     git           [https://git-scm.com]
6     ocaml 4.14.0  [https://ocaml.org]
7         If not present will be downloaded from the network and
8         built/used locally without system-wide installation.
9         This requires either:
10             wget    [https://www.gnu.org/software/wget]
11             or curl [https://curl.haxx.se]
13     asciidoc      [https://asciidoc.org/]
14                   Is needed if one wants to build man pages
16 To download mupdf+prerequisites that llpp is known to work with:
17    - mkdir build && sh misc/getmupdf.sh build/mupdf
19 To build llpp (binary will be in build/llpp):
20    - bash build.bash build
22    # by default llpp looks for .config/llpp.conf file
23    # hence .config directory should be present otherwise
24    # llpp will fail to start
26 To build man pages (will be in build/doc/[name].1)
27    - bash build.bash build doc