From 9be9ed306206a407261560a4d6d9d86ac969fbb5 Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Sat, 1 Apr 2023 21:19:06 +0300 Subject: [PATCH] docs... Signed-off-by: Alex A. Naanou --- examples/book/README.md | 156 ++++++++++++++++++++-------------------- 1 file changed, 79 insertions(+), 77 deletions(-) diff --git a/examples/book/README.md b/examples/book/README.md index 9b15607..5eb76bc 100644 --- a/examples/book/README.md +++ b/examples/book/README.md @@ -1,77 +1,79 @@ -Full book example -================= - -This directory contains a full book example. - -``` -book/ -├── templates/ . . . . . . . . . . . . Templates used to buld spreads -│   └── ... (used by: make-spreads.sh) -├── spreads/ . . . . . . . . . . . . . Spread layout -│   └── ... (used by: make-spreads.sh) -├── captions/ . . . . . . . . . . . . . Image captions -│   └── ... (used by: make-spreads.sh) -├── hi-res/ . . . . . . . . . . . . . . High resolution graphics -│   └── ... (used by: make-spreads.sh) -├── Makefile -├── setup.tex . . . . . . . . . . . . . Book setup and configuration -│ This file contains all the book -│ geometry, colors and other -│ settings common to all comoponents -│ of the book. -├── block.tex . . . . . . . . . . . . . General page block layout. -├── spreads.tex . . . . . . . . . . . . Book spereads -│ (generated by: make-spreads.sh) -├── cover.tex -├── endpaper.tex -├── jacket.tex -└── ... -``` - -Note that this is by no means the only or most optomal project -structure, but it is a good enough starting point that evolved through -several, big and small project to start the next one from (at least -for me, subjectively). - - - -Building --------- - -To build all components: -```shell -$ make all -``` - -To build a specific component: -```shell -$ make block.pdf -``` - -`block.pdf` in this case. - - - - -Structure ---------- - -### `setup.tex` - -### `spreads.tex` - -### `cover.tex` / `jacket.tex` / `endpaper.tex` / .. - - - -Workflow --------- - -XXX - - -For information about building spreads see: -[make-spreads.sh](../../scripts/README.md) - - - +Full book example +================= + +This directory contains a full book example. + +``` +book/ +├── templates/ . . . . . . . . . . . . Templates used to buld spreads +│   └── ... (used by: make-spreads.sh) +├── spreads/ . . . . . . . . . . . . . Spread layout +│   └── ... (used by: make-spreads.sh) +├── captions/ . . . . . . . . . . . . . Image captions +│   └── ... (used by: make-spreads.sh) +├── hi-res/ . . . . . . . . . . . . . . High resolution graphics +│   └── ... (used by: make-spreads.sh) +├── Makefile +├── setup.tex . . . . . . . . . . . . . Book setup and configuration +│ This file contains all the book +│ geometry, colors and other +│ settings common to all comoponents +│ of the book. +├── block.tex . . . . . . . . . . . . . General page block layout. +├── spreads.tex . . . . . . . . . . . . Book spereads +│ (generated by: make-spreads.sh) +├── cover.tex +├── endpaper.tex +├── jacket.tex +└── ... +``` + +Note that this is by no means the only or most optomal project +structure, but it is a good enough starting point that evolved through +several, big and small project to start the next one from (at least +for me, subjectively). + + + +Building +-------- + +To build all components: +```shell +$ make all +``` + +To build a specific component: +```shell +$ make block.pdf +``` + +`block.pdf` in this case. + + + + +Structure +--------- + +### `setup.tex` + +### `spreads.tex` + +### `cover.tex` / `jacket.tex` / `endpaper.tex` / .. + +### `web.tex` + + + +Workflow +-------- + +XXX + + +For information about building spreads see: +[make-spreads.sh](../../scripts/README.md) + + +