linuxboot /book
LinuxBoot book which contains the documentation in markdown format
★ 300⑂ 53👁 30⑃ 132● 89▤ 0
+0
Daily
300
stars
53
forks
30
watchers
132
prs
89
issues
0
releases
README
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: sh 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. I18n Translations are in po/. They are built with i18n.sh. Until there is a native mdBook plugin, see the Makefile for how the translations are integrated. Note that make run / mdbook serve do not integrate the translations at this point. The make build target will build everything into book/, which you can then statically serve. Acknowledgments In alphabetical order: Andrea Barberio Gan Shun Lim Johnny Lin Jonathan Zhang Philipp Deppenwiese Prachi Laud Ronald Minnich Ryan O'Leary
Top issues
#172gotchas for kexec6 comments · 2025-05-25#86list petitboot as an implementation example6 comments · 2024-04-02#134How to use the FreeBSD kboot application4 comments · 2025-04-30#114Comparing kexec implementations, features3 comments · 2025-04-15#113Comparing coreutils implementations3 comments · 2025-04-15#38QEMU localboot cannot see block devices3 comments · 2019-12-02#196LinuxBoot using nolibc2 comments · 2025-10-29#135Netflix case study2 comments · 2025-04-30