flynx/photobook
1
0
Fork 0
mirror of https://github.com/flynx/photobook.git synced 2025-12-17 00:51:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

added notes about generated doc source...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2023-04-26 20:56:44 +03:00
parent 2034e4fdfe
commit 0d14bb32e3
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -44,6 +44,12 @@ For more info on `make` targets see the: [./Makefile](./Makefile)
## Notes
- The main refetence is inline with the source [photobook.cls](./photobook.cls)
thus it is both human-readable next to the code it documents and is
used to build the `photobook.pdf`.
Extracting the documentation source (`photobook*.tex`) is done
by [make](./Makefile) via [cls2tex.sh](scripts/README.md#cls2texsh) when
building the docs, see them for more info.
- There is a bug in default captions not being typeset correctly if too
long, a workaround is to place them in a `minipage` like this:
```latex
@ -72,3 +78,4 @@ Copyright (c) 2021-2023, Alex A. Naanou,
All rights reserved.
<!-- vim:set ts=4 sw=4 nowrap : -->