diff --git a/README.md b/README.md index eacbe5b..d7767aa 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,42 @@ -# book +# The LinuxBoot Book -Documentation for LinuxBoot +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. ## Table of Contents | # | Chapter | | --- | ------- | -| 01 | Introduction | -| 02 | [Getting Started in 20mins](getting_started/README.md) | -| 03 | LinuxBoot | -| 04 | Minimal Linux Kernel | -| 05 | The Initramfs | -| 05a | ---> HEADS | -| 05b | ---> [U-root: A Go-based, Firmware Embeddable Root File System](u-root/README.md) | -| 06 | UEFI | -| 06a | ---> EDKII | -| 06b | ---> OVMF | -| 07 | Tools | -| 07a | ---> UEFITool and UEFIReplace | -| 07b | ---> [UEFI Tool Kit](UEFI_Tool_Kit/README.md) | -| 07c | ---> LinuxBoot Scripts (Trammell Hudson) | -| 07d | ---> FMAP tool | -| 08 | TPMs | -| 09 | SecureBoot and BootGuard | -| 10 | [coreboot, u-root and systemboot](coreboot.u-root.systemboot/README.md) | -| 11 | Arm + u-boot | -| 12 | [DUT, Device Under Test framework](dut/README.md) | -| 13 | [CPU, wherever you go, there your files are](cpu/README.md) | -| 14 | [Case Studies](case_studies/README.md) | +| 01 | **Introduction** | +| [02](getting_started/README.md) | **Getting Started in 20 mins** | +| 02a |     Getting started on QEMU | +| 02a |     Getting started on hardware | +| 03 | **LinuxBoot** | +| 04 | **Minimal Linux Kernel** | +| 05 | **The Initramfs** | +| 05a |     HEADS | +| [05b](u-root/README.md) | **U-root: A Go-based, Firmware Embeddable Root File System** | +| 06 | **UEFI** | +| 06a |     EDKII | +| 06b |     OVMF | +| 07 | **Tools** | +| 07a |     UEFITool and UEFIReplace | +| [07b](UEFI_Tool_Kit/README.md) |     UEFI Tool Kit | +| 07c |     LinuxBoot Scripts (Trammell Hudson) | +| 07d |     FMAP tool | +| 08 | **TPMs** | +| 09 | **SecureBoot and BootGuard** | +| [10](coreboot.u-root.systemboot/README.md) | **coreboot, u-root and systemboot** | +| 11 | **Arm + u-boot** | +| [12](dut/README.md) | **DUT, Device Under Test framework** | +| [13](cpu/README.md) | **CPU, wherever you go, there your files are** | +| [14](case_studies/README.md) | **Case Studies** | ## Acknowledgments