photobook/README.md
Alex A. Naanou 5765879aba more notes...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
2023-02-27 17:27:55 +03:00

1.7 KiB

photobook

LaTeX document class for making photo books.

Build requirements for docs

  • LaTeX tool chain (including: lualatex, latexmk, ..)
    The simplest way to get started is TeX Live, either a full install or for specific modules see the Packages section in photobook.cls,
  • Un*x-like environment (bash, GNU Make, coreutils, ...),
    on Windows systems, either Cygwin or WSL/WSL2 should work fine.

Build / Install

The package is available on:

To install from source:

# get the source...
$ git clone https://github.com/flynx/photobook.git

# if desired, install in the user context...
$ cd ./photobook
$ make install

If only building the docs is required without installing:

$ make pdf 

For more info on make targets see the: ./Makefile

Notes

  • There is a bug in default captions not being typeset correctly if too long, a workaround is to place them in a minipage like this:
    \imagecell{%
        \begin{minipage}{\cellwidth}%
            long caption text...
        \end{minipage}%
    }{some-image}
    
    (still working on a solution for this).
  • photobook is mostly used with lualatex, other engines are mostly supported but some features may misbehave.

Authors

Alex A. Naanou

License

BSD 3-Clause License

Copyright (c) 2021-2023, Alex A. Naanou, All rights reserved.