diff options
Diffstat (limited to 'macros/latex/contrib/photobook/README.md')
-rw-r--r-- | macros/latex/contrib/photobook/README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/macros/latex/contrib/photobook/README.md b/macros/latex/contrib/photobook/README.md new file mode 100644 index 0000000000..cbab31c280 --- /dev/null +++ b/macros/latex/contrib/photobook/README.md @@ -0,0 +1,52 @@ +# photobook + +[LaTeX](https://www.latex-project.org/) 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](https://www.tug.org/texlive/), + either a full install or for specific modules see the _Packages_ section + in [photobook.cls](./photobook.cls), +- Un\*x-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 pdf +``` + +For more info on `make` targets see the: [./Makefile](./Makefile) + + + +## Authors + +[Alex A. Naanou](https://github.com/flynx) + + + +## License + +[BSD 3-Clause License](./LICENSE) + +Copyright (c) 2021-2022, Alex A. Naanou, +All rights reserved. + + |