flynx/photobook
1
0
Fork 0
mirror of https://github.com/flynx/photobook.git synced 2025-10-28 18:00:10 +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
=================
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.
<!-- XXX add basic introspection to Makefike??? -->
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)
<!-- vim:set ts=4 sw=4 nowrap : -->
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.
<!-- XXX add basic introspection to Makefike??? -->
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)
<!-- vim:set ts=4 sw=4 nowrap : -->