README.md

The LinuxBoot Book

LinuxBoot is a project that aims to replace specific firmware functionality with a Linux kernel and runtime. Over the years this project has grown to include various initiatives with the overarching goal of moving from obscure, complex firmware to simpler, open source firmware.

This is the official site of documentation for the LinuxBoot project. The book provides guidance on how to get started, and gives overviews and background on the different aspects of LinuxBoot.

Contributing

This book is written with mdBook. When installed, run mdbook serve and you will get a local webserver. For more details, please refer to the mdBook documentation.

Some pages render diagrams using mermaid.js, which is preprocessed with mdbook-mermaid.

To check that all links are still available, mdbook-linkcheck also runs in CI.

For convenience, the Makefile lets you set up and run the environment:

make prepare
make run

The book is linted with markdownlint and Vale. Follow the official documentation to install markdownlint and install Vale. Then run vale sync to download the necessary styles.

From the root directory of the repository run mdl /src/example.md and vale src/example.md. Add words that trigger false positive spelling errors to ci/vale/styles/config/vocabularies/LinuxBoot/accept.txt.

Acknowledgments

In alphabetical order:

• Andrea Barberio
• Gan Shun Lim
• Johnny Lin
• Jonathan Zhang
• Philipp Deppenwiese
• Prachi Laud
• Ronald Minnich
• Ryan O'Leary