Skip to content

Commit

Permalink
Update README wording for clarity (#267)
Browse files Browse the repository at this point in the history
* Update README wording for clarity

* Add parallel builds to the README

They are now safe and runs much faster.
  • Loading branch information
cedounet authored Oct 30, 2023
1 parent 1ce9802 commit 7537d4c
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -43,20 +43,21 @@ 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/
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/`
Expand All @@ -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)

Expand Down

0 comments on commit 7537d4c

Please sign in to comment.