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

refactored the readme...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2023-04-29 16:26:35 +03:00
parent 1ca673cf64
commit f1fbc82fca
1 changed files with 25 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -4,24 +4,16 @@ photobook
[LaTeX](https://www.latex-project.org/) document class for making photo books.
## Build requirements for docs
- LaTeX tool chain (including: `lualatex`, `latexmk`, ..)
The simplest way to get started is [TeX Live](https://www.tug.org/texlive/),
either a full install or for specific modules see the _Packages_ section
in [photobook.cls](./photobook.cls),
- Un\*x-like environment (`bash`, GNU Make, coreutils, ...),
on Windows systems, either [Cygwin](https://www.cygwin.com/) or
[WSL/WSL2](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)
should work fine.
## Install / Build
The simplest way to install is to use either
[TeX Live](https://www.tug.org/texlive/)'s or [MiLTeX](https://miktex.org/)'s
standard way to install modules.
The package is distributed via CTAN: https://ctan.org/pkg/photobook
## Build / Install
The package is available on:
- CTAN: https://ctan.org/pkg/photobook
- GitHub: https://github.com/flynx/photobook
The source is maintained at GitHub: https://github.com/flynx/photobook
To install from source:
@ -41,7 +33,12 @@ printed by calling:
$ make depends
```
If only building the docs is required without installing, do:
# 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:
```shell
$ make pdf
```
@ -49,6 +46,19 @@ $ make pdf
For more info on `make` targets see the: [./Makefile](./Makefile)
### Build requirements for docs
- LaTeX tool chain (including: `lualatex`, `latexmk`, ..)
The simplest way to get started is [TeX Live](https://www.tug.org/texlive/),
either a full install or for specific modules see the _Packages_ section
in [photobook.cls](./photobook.cls),
- Un\*x-like environment (`bash`, GNU Make, coreutils, ...),
on Windows systems, either [Cygwin](https://www.cygwin.com/) or
[WSL/WSL2](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)
should work fine.
## Notes
- The main refetence is inline with the source [photobook.cls](./photobook.cls)