Rework readme (#4)

Make text adhear to text width and add new cover image.
This commit is contained in:
Hendrik Kleinwaechter
2022-05-06 10:15:24 +02:00
committed by GitHub
parent a5409e3a0c
commit 34563ecba8
3 changed files with 31 additions and 13 deletions

View File

@@ -1,25 +1,43 @@
# The Sourdough Framework # The Sourdough Framework (WIP)
![The perfect sourdough bread](book/images/sourdough-starter.jpg) The sourdough framework is an open source book dedicated to
helping you to make the best possible sourdough bread at home.
Rather than providing recipes this book intends to provide a
framework that enables you to bake bread in your individual
environment. Every flour, every sourdough and every home setup
is different. This makes making sourdough bread at home so hard.
Say no more, this book will help you to master making bread in
your environment.
The sourdough framework is an open source book dedicated to helping you to make the best possible sourdough bread at home. Rather than providing recipes this book intends to provide a framework that enables you to bake bread in your individual environment. Every flour, every sourdough and every home setup is different. This makes making sourdough bread at home so hard. Say no more, this book will help you to master making bread in your environment. ![Cover image](cover.jpg)
## Background story ## Motivation
<img src="cover.png" alt="The book cover" width="400"/>
4 years after launching [the-bread-code repo](https://github.com/hendricius/the-bread-code) repo and the [pizza-dough repo](https://github.com/hendricius/pizza-dough) I present to you The Sourdough Framework. TSF will be a completely free community driven open source ebook on making 4 years after launching [the-bread-code repo](https://github.com/hendricius/the-bread-code)
sourdough bread. My dream is to enable everyone around the world to have the tools and the [pizza-dough repo](https://github.com/hendricius/pizza-dough)
at hand to bake fresh bread. I present to you The Sourdough Framework book. When not
working as a software engineer I teach people how to bake bread on
[my YouTube channel.](https://youtube.com/c/thebreadcode). Several
people have asked to have a written down version of my teachings.
I believe that knowledge like this is essential to everyone.
That's why I decided to open source my knowledge hoping
that it will reach more people all over the world.
I believe in open source and that's why this book will also be open source. I plan to make a hardcover version, but the digital version will always be free. You can help me make my dream reality by [funding my Ko-Fi campaign](https://ko-fi.com/thebreadcode) to write the first part of the book. If the first part is a success, then I will be asking the community to decide on the next chapters. Another campaign will follow. This way we can shape the future of this book together. ## Status
I will use the money to take time off from my job. Furthermore as I am not a native speaker I will try to find some help with improving the text. Additionally I need to use some of the money to pay a layouter for the book from the community. The book is still work in progress. History, introducing
and troubleshooting sections have been finished so far.
## Download alpha version of book ## Compiled book
You can follow the progress in the `book/` folder and you can [download the compiled version here](https://www.the-bread-code.io/book.pdf). You can follow the progress in the `book/` folder
and you can [download the compiled version here](https://thbrco.io/book).
## Support ## Support
Do you find a typo, or you feel the wording could be improved? Feel free to open up a pull request at any time. Thank you for the support! Do you find a typo, or you feel the wording could be improved?
Feel free to open up a pull request at any time.
If you would like to contribute financially to the project and
support it financially you can do so via my [ko-fi page.](https://ko-fi.com/thebreadcode)

BIN
cover.jpg Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

BIN
cover.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.9 MiB