Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2021-12-07 15:19:09 +03:00
parent a21ad495db
commit 58eb1f368c

View File

@ -2,19 +2,41 @@
LaTeX class for making photo books.
<!-- XXX Requirements... -->
To build the documentation (`photobook.pdf`) use:
## Build requirements
- LaTeX tool chain (including: `lualatex`, `latexmk`, ..)
The simplest way to get started is [TeX Live](https://www.tug.org/texlive/),
either a full install or for specific modules see the _Packages_ section
in [photobook.cls](./photobook.cls),
- U\*ix-like environment (`bash`, GNU Make, coreutils, ...),
on Windows systems either [Cygwin](https://www.cygwin.com/) or
[WSL/WSL2](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)
should work fine.
## Build / Install
```shell
# 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:
```shell
$ make doc
```
To install to the user context:
```shell
$ make install
```
For more info on `make` targets see the: [./Makefile](./Makefile)
<!--
XXX ToDo:
- manual
- workflow
-->