diff options
author | Norbert Preining <norbert@preining.info> | 2023-06-27 03:00:56 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2023-06-27 03:00:56 +0000 |
commit | a0b68c12d9e67182560eb31f202f3e86f0e4a5de (patch) | |
tree | 5d0d249a669c45205fc467d62bd18d5edb2ae3ae /macros/latex/contrib/photobook/README.md | |
parent | a2ebe77da32f4499676953174f774795b0d054fb (diff) |
CTAN sync 202306270300
Diffstat (limited to 'macros/latex/contrib/photobook/README.md')
-rw-r--r-- | macros/latex/contrib/photobook/README.md | 52 |
1 files changed, 34 insertions, 18 deletions
diff --git a/macros/latex/contrib/photobook/README.md b/macros/latex/contrib/photobook/README.md index 004a438e86..54e29d5eba 100644 --- a/macros/latex/contrib/photobook/README.md +++ b/macros/latex/contrib/photobook/README.md @@ -4,27 +4,19 @@ 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. - +Available on: +- CTAN: https://ctan.org/pkg/photobook +- GitHub: https://github.com/flynx/photobook -## Build / Install +## Install / Build -The package is available on: -- CTAN: https://ctan.org/pkg/photobook -- GitHub: https://github.com/flynx/photobook +The simplest way to install is to use either +[TeX Live](https://www.tug.org/texlive/)'s or [MiLTeX](https://miktex.org/)'s +standard way to install modules. -To install from source: +Installing from source: ```shell # get the source... $ git clone https://github.com/flynx/photobook.git @@ -34,14 +26,38 @@ $ cd ./photobook $ make install ``` -If only building the docs is required without installing: +The `photobook` document class requires a set of modules to be installed +for it to function, the full list is included in the docs and can be +printed by calling: ```shell -$ make pdf +$ make depends ``` For more info on `make` targets see the: [./Makefile](./Makefile) + +# Documentation + +Pre-built documentation can be found on +[CTAN](http://mirrors.ctan.org/macros/latex/contrib/photobook/photobook.pdf) +or it can be built from source by: +```shell +$ make pdf +``` + +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. + + + ## Notes - The main refetence is inline with the source [photobook.cls](./photobook.cls) |