Better formatting for table of contents

This also removes the numbers from the subdirectories until the chapter numbers are more stable. Signed-off-by: Ryan O'Leary <[email protected]>
linuxboot · Jul 19, 2019 · 308773a · 308773a
1 parent f7ca284
commit 308773a
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -1,36 +1,39 @@
 # book
 
-LinuxBoot book which contains the documentation in markdown format
+Documentation for LinuxBoot
 
 ## Table of Contents
 
-1. Introduction
-2. Getting Started in 20mins
-  * apt-get install qemu ovmf
-  * git clone github.com/linuxboot/linuxboot
-  * Download existing Linux bzImage
-  * git clone UEFIReplace
-  * Shell replacement
-3. LinuxBoot
-4. Minimal Linux kernel
-5. The Initramfs:
-  * HEADS
-  * NERF
-6. UEFI
-  * EDKII
-  * OVMF
-7. Tools:
-  * UEFITool and UEFIReplace
-  * [UEFI Tool Kit (Ryan O'Leary and Gan Shun)](7b.UEFI_Tool_Kit/README.md)
-  * LinuxBoot Scripts (Trammell Hudson)
-  * FMAP tool
-8. TPMs
-9. SecureBoot and BootGuard
-10. u-root
-  * [U-root: A Go-based, Firmware Embeddable Root File System](10.u-root/README.md)
-11. [coreboot, u-root and systemboot](11.coreboot.u-root.systemboot/README.md)
-12. Arm + u-boot
-13. DUT, a simple Device Under Test framework [DUT, Device Under Test framework] (13.dut/README.md)
-14. CPU, an ssh style command which lets you see your files from anywhere. [CPU, wherever you go, there your files are] (14.cpu/README.md)
-15. [Case Studies](case_studies/README.md)
-15. Conclusion
+| #   | 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) |
+
+## Acknowledgments
+
+* Andrea Barberio
+* Johnny Lin
+* Jonathan Zhang
+* Philipp Deppenwiese
+* Ronald Minnich
+* Ryan O'Leary
diff --git a/7b.UEFI_Tool_Kit/README.md → UEFI_Tool_Kit/README.md b/7b.UEFI_Tool_Kit/README.md → UEFI_Tool_Kit/README.md
@@ -1,4 +1,4 @@
-## 7b: UEFI Tool Kit
+## UEFI Tool Kit
 
 Authors: Ryan O'Leary, Gan Shun Lim and Andrea Barberio
 

diff --git a/11.coreboot.u-root.systemboot/README.md → coreboot.u-root.systemboot/README.md b/11.coreboot.u-root.systemboot/README.md → coreboot.u-root.systemboot/README.md
diff --git a/....systemboot/linux-4.19.6-linuxboot.config → ....systemboot/linux-4.19.6-linuxboot.config b/....systemboot/linux-4.19.6-linuxboot.config → ....systemboot/linux-4.19.6-linuxboot.config
diff --git a/14.cpu/README.md → cpu/README.md b/14.cpu/README.md → cpu/README.md
diff --git a/13.dut/README.md → dut/README.md b/13.dut/README.md → dut/README.md
diff --git a/getting_started/README.md b/getting_started/README.md
@@ -0,0 +1,7 @@
+# Getting Started
+
+  * apt-get install qemu ovmf
+  * git clone github.com/linuxboot/linuxboot
+  * Download existing Linux bzImage
+  * git clone UEFIReplace
+  * Shell replacement
diff --git a/10.u-root/README.md → u-root/README.md b/10.u-root/README.md → u-root/README.md