From 58eb1f368ce611312328631bbd9e0e6bd2a82908 Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Tue, 7 Dec 2021 15:19:09 +0300 Subject: [PATCH] docs... Signed-off-by: Alex A. Naanou --- README.md | 40 +++++++++++++++++++++++++++++++--------- 1 file changed, 31 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 81eba02..056e7d4 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,41 @@ LaTeX class for making photo books. - -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) + + + +