From ace4cc3e6fc353c88ca62143d04575e45d3ea18a Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Sat, 16 Sep 2023 11:02:43 +0300 Subject: [PATCH 1/2] added a ref to the dummy book... Signed-off-by: Alex A. Naanou --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index bf6ba57..98237ce 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,10 @@ Build requirements for docs: should work fine. +A full book (dummy) example is included in ./examples/book/ and can be +used as a reference / starting point. + + ## Notes From 60a4e8b6ef062c8b6300afa50c4bd07442757187 Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Sat, 16 Sep 2023 11:15:01 +0300 Subject: [PATCH 2/2] refactored the readme a bit... Signed-off-by: Alex A. Naanou --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 98237ce..13daa3c 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,17 @@ 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: +[CTAN](http://mirrors.ctan.org/macros/latex/contrib/photobook/photobook.pdf). + + +A full book (dummy) example is included in [./examples/book/](./examples/book/) +and can be used as a reference / starting point. + + + +## Building documentation + +Building the reference from source is done by: ```shell $ make pdf ``` @@ -57,10 +66,6 @@ Build requirements for docs: should work fine. -A full book (dummy) example is included in ./examples/book/ and can be -used as a reference / starting point. - - ## Notes