flynx/photobook
1
0
Fork 0
mirror of https://github.com/flynx/photobook.git synced 2025-10-29 10:20:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2023-04-01 21:19:06 +03:00
parent 2a29e29680
commit 9be9ed3062
1 changed files with 79 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

156
examples/book/README.md
View File

@ -1,77 +1,79 @@
Full book example Full book example
================= =================
This directory contains a full book example. This directory contains a full book example.
``` ```
book/ book/
├── templates/ . . . . . . . . . . . . Templates used to buld spreads ├── templates/ . . . . . . . . . . . . Templates used to buld spreads
│   └── ... (used by: make-spreads.sh) │   └── ... (used by: make-spreads.sh)
├── spreads/ . . . . . . . . . . . . . Spread layout ├── spreads/ . . . . . . . . . . . . . Spread layout
│   └── ... (used by: make-spreads.sh) │   └── ... (used by: make-spreads.sh)
├── captions/ . . . . . . . . . . . . . Image captions ├── captions/ . . . . . . . . . . . . . Image captions
│   └── ... (used by: make-spreads.sh) │   └── ... (used by: make-spreads.sh)
├── hi-res/ . . . . . . . . . . . . . . High resolution graphics ├── hi-res/ . . . . . . . . . . . . . . High resolution graphics
│   └── ... (used by: make-spreads.sh) │   └── ... (used by: make-spreads.sh)
├── Makefile ├── Makefile
├── setup.tex . . . . . . . . . . . . . Book setup and configuration ├── setup.tex . . . . . . . . . . . . . Book setup and configuration
│ This file contains all the book │ This file contains all the book
│ geometry, colors and other │ geometry, colors and other
│ settings common to all comoponents │ settings common to all comoponents
│ of the book. │ of the book.
├── block.tex . . . . . . . . . . . . . General page block layout. ├── block.tex . . . . . . . . . . . . . General page block layout.
├── spreads.tex . . . . . . . . . . . . Book spereads ├── spreads.tex . . . . . . . . . . . . Book spereads
│ (generated by: make-spreads.sh) │ (generated by: make-spreads.sh)
├── cover.tex ├── cover.tex
├── endpaper.tex ├── endpaper.tex
├── jacket.tex ├── jacket.tex
└── ... └── ...
``` ```
Note that this is by no means the only or most optomal project 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 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 several, big and small project to start the next one from (at least
for me, subjectively). for me, subjectively).
Building Building
-------- --------
To build all components: To build all components:
```shell ```shell
$ make all $ make all
``` ```
To build a specific component: To build a specific component:
```shell ```shell
$ make block.pdf $ make block.pdf
``` ```
`block.pdf` in this case. `block.pdf` in this case.
<!-- XXX add basic introspection to Makefike??? --> <!-- XXX add basic introspection to Makefike??? -->
Structure Structure
--------- ---------
### `setup.tex` ### `setup.tex`
### `spreads.tex` ### `spreads.tex`
### `cover.tex` / `jacket.tex` / `endpaper.tex` / .. ### `cover.tex` / `jacket.tex` / `endpaper.tex` / ..
### `web.tex`
Workflow
--------
Workflow
XXX --------
XXX
For information about building spreads see:
[make-spreads.sh](../../scripts/README.md)
For information about building spreads see:
[make-spreads.sh](../../scripts/README.md)
<!-- vim:set ts=4 sw=4 nowrap : -->
<!-- vim:set ts=4 sw=4 nowrap : -->