mchapman/the-sourdough-framework
1
0
Fork 0
mirror of https://github.com/hendricius/the-sourdough-framework synced 2025-11-08 12:11:11 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README wording for clarity (#267)

Browse Source 
* Update README wording for clarity

* Add parallel builds to the README

They are now safe and runs much faster.
This commit is contained in:
cedounet
2023-10-30 10:48:00 +00:00
committed by GitHub
parent 1ce9802689
commit 7537d4c36f
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -33,7 +33,7 @@ make
Then you can check out the file `book/book.pdf`
If you want to 🍞 bake all the versions including ebook variants (.pdf, .epub
in colour or size optimized Black&White), run:
in colour and size optimized Black&White), run:
```console
make bake
@@ -43,8 +43,9 @@ You can check the files in the folder `book/release/`
## 🍞 Baking the book locally (LaTeX)
Make sure you have `biber` and `latexmk` installed. Refer to your system's
installation instructions for LaTeX. To create the serif .pdf format, run:
Make sure you have `biber`, `latexmk` and ``ImageMagick`` installed. Refer to
your system's installation instructions for LaTeX. To create the serif .pdf
format, run:
```console
cd book/
@@ -52,11 +53,11 @@ make
```
If you want to 🍞 bake all the versions including ebook variants (.pdf, .epub
in colour or size optimized Black&White), run:
in colour and size optimized Black&White), run:
```console
cd book/
make bake
make -j bake
```
You can check the files in the folder `book/release/`
@@ -74,16 +75,16 @@ The below versions are automatically built on every push to the `main` branch.
* [Download compiled .pdf version](https://www.the-bread-code.io/book.pdf)
* [Download compiled .epub version](https://www.the-bread-code.io/book.epub)
There's an additional enhanced accessibility version using a sans serif font:
There's an additional enhanced accessibility version using a sans-serif font:
* [Download compiled .pdf version](https://www.the-bread-code.io/book-sans-serif.pdf)
* [Download compiled sans-serif .pdf version](https://www.the-bread-code.io/book-sans-serif.pdf)
An additional black and white ebook is provided with a greatly reduced file size. This
shrinks the book from more than 50MB down to ~5MB:
An additional black and white ebook is provided with a greatly reduced file
size. This shrinks the book from more than 50MB down to ~5MB:
* [Download compiled .epub version](https://www.the-bread-code.io/bw-book.epub)
* [Download compiled B&W .epub version](https://www.the-bread-code.io/bw-book.epub)
## Online HTML version (WIP)
## Online HTML version
Head over to [https://www.the-sourdough-framework.com](https://www.the-sourdough-framework.com)