bootstrap mdBook setup

see https://rust-lang.github.io/mdBook/guide/creating.html Signed-off-by: Daniel Maslowski <[email protected]>
linuxboot · Mar 27, 2024 · 150dad8 · 150dad8
1 parent fcac8bc
commit 150dad8
Show file tree

Hide file tree

Showing 38 changed files with 21 additions and 21 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1 @@
-*~
+book
diff --git a/README.md b/README.md
@@ -9,26 +9,6 @@ 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|&emsp; &emsp;Title|
-|:-----:|:--------------|
-| [1](README.md)|&emsp; &emsp;Overview and Table of Contents|
-| [2](intro/README.md)|&emsp; &emsp;LinuxBoot Introduction|
-| [2a](getting_started/README.md)|&emsp; &emsp;Getting Started|
-| [3](components/README.md)|&emsp; &emsp;LinuxBoot Components|
-| [4](u-root/README.md)|&emsp; &emsp;All about u-root|
-| [5](utilities/README.md)|&emsp; &emsp;LinuxBoot utilities|
-| [5a](UEFI_Tool_Kit/README.md)|&emsp; &emsp;UEFI Tool Kit|
-| [5b](cpu/README.md)|&emsp; &emsp;The magical cpu command|
-| [5c](dut/README.md)|&emsp; &emsp;Device Under Test|
-| [6](implementation/README.md)|&emsp; &emsp;Implementing LinuxBoot|
-| [6a](coreboot.u-root.systemboot/README.md)|&emsp; &emsp;LinuxBoot using coreboot, u-root and systemboot|
-| [7](glossary/README.md)|&emsp; &emsp;Glossary|
-| [8](naming/README.md) |&emsp; &emsp;Naming|
-| [9](case_studies/README.md)|&emsp; &emsp;Case Studies|
-| [10](faq/README.md)|&emsp; &emsp;Frequently Asked Questions|
-
 ## Acknowledgments
 
 In alphabetical order:

diff --git a/book.toml b/book.toml
@@ -0,0 +1,6 @@
+[book]
+authors = ["LinuxBoot authors"]
+language = "en"
+multilingual = false
+src = "src"
+title = "LinuxBoot"
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -0,0 +1,14 @@
+- [LinuxBoot Introduction](intro/README.md)
+  * [Getting Started](getting_started/README.md)
+- [LinuxBoot Components](components/README.md)
+- [All about u-root](u-root/README.md)
+- [LinuxBoot utilities](utilities/README.md)
+  * [UEFI Tool Kit](UEFI_Tool_Kit/README.md)
+  * [The magical cpu command](cpu/README.md)
+  * [Device Under Test](dut/README.md)
+- [Implementing LinuxBoot](implementation/README.md)
+  * [LinuxBoot using coreboot, u-root and systemboot](coreboot.u-root.systemboot/README.md)
+- [Glossary](glossary/README.md)
+- [Naming](naming/README.md)
+- [Case Studies](case_studies/README.md)
+- [Frequently Asked Questions](faq/README.md)
diff --git a/UEFI_Tool_Kit/README.md → src/UEFI_Tool_Kit/README.md b/UEFI_Tool_Kit/README.md → src/UEFI_Tool_Kit/README.md
diff --git a/case_studies/Google_study/README.md → src/case_studies/Google_study/README.md b/case_studies/Google_study/README.md → src/case_studies/Google_study/README.md
diff --git a/case_studies/README.md → src/case_studies/README.md b/case_studies/README.md → src/case_studies/README.md
diff --git a/case_studies/TiogaPass/README.md → src/case_studies/TiogaPass/README.md b/case_studies/TiogaPass/README.md → src/case_studies/TiogaPass/README.md
diff --git a/case_studies/TiogaPass/linux_config → src/case_studies/TiogaPass/linux_config b/case_studies/TiogaPass/linux_config → src/case_studies/TiogaPass/linux_config
diff --git a/case_studies/ocp-wedge-100s.md → src/case_studies/ocp-wedge-100s.md b/case_studies/ocp-wedge-100s.md → src/case_studies/ocp-wedge-100s.md
diff --git a/components/README.md → src/components/README.md b/components/README.md → src/components/README.md
diff --git a/coreboot.u-root.systemboot/README.md → src/coreboot.u-root.systemboot/README.md b/coreboot.u-root.systemboot/README.md → src/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/cpu/README.md → src/cpu/README.md b/cpu/README.md → src/cpu/README.md
diff --git a/dut/README.md → src/dut/README.md b/dut/README.md → src/dut/README.md
diff --git a/faq/README.md → src/faq/README.md b/faq/README.md → src/faq/README.md
diff --git a/getting_started/README.md → src/getting_started/README.md b/getting_started/README.md → src/getting_started/README.md
diff --git a/glossary/README.md → src/glossary/README.md b/glossary/README.md → src/glossary/README.md
diff --git a/images/Case-study-step1.svg → src/images/Case-study-step1.svg b/images/Case-study-step1.svg → src/images/Case-study-step1.svg
diff --git a/images/Case-study-step1a.svg → src/images/Case-study-step1a.svg b/images/Case-study-step1a.svg → src/images/Case-study-step1a.svg
diff --git a/images/Case-study-step1b.svg → src/images/Case-study-step1b.svg b/images/Case-study-step1b.svg → src/images/Case-study-step1b.svg
diff --git a/images/Case-study-step2.svg → src/images/Case-study-step2.svg b/images/Case-study-step2.svg → src/images/Case-study-step2.svg
diff --git a/images/Case-study-step3.svg → src/images/Case-study-step3.svg b/images/Case-study-step3.svg → src/images/Case-study-step3.svg
diff --git a/images/Case-study-step4.svg → src/images/Case-study-step4.svg b/images/Case-study-step4.svg → src/images/Case-study-step4.svg
diff --git a/images/Case-study-step5.svg → src/images/Case-study-step5.svg b/images/Case-study-step5.svg → src/images/Case-study-step5.svg
diff --git a/images/Case-study-step6.svg → src/images/Case-study-step6.svg b/images/Case-study-step6.svg → src/images/Case-study-step6.svg
diff --git a/images/LinuxBoot-components.svg → src/images/LinuxBoot-components.svg b/images/LinuxBoot-components.svg → src/images/LinuxBoot-components.svg
diff --git a/images/UEFI-versus-LinuxBoot.svg → src/images/UEFI-versus-LinuxBoot.svg b/images/UEFI-versus-LinuxBoot.svg → src/images/UEFI-versus-LinuxBoot.svg
diff --git a/images/cpu_first_step.svg → src/images/cpu_first_step.svg b/images/cpu_first_step.svg → src/images/cpu_first_step.svg
diff --git a/images/cpu_overview.svg → src/images/cpu_overview.svg b/images/cpu_overview.svg → src/images/cpu_overview.svg
diff --git a/images/cpu_second_step.svg → src/images/cpu_second_step.svg b/images/cpu_second_step.svg → src/images/cpu_second_step.svg
diff --git a/images/cpu_startup.svg → src/images/cpu_startup.svg b/images/cpu_startup.svg → src/images/cpu_startup.svg
diff --git a/images/cpu_third_step.svg → src/images/cpu_third_step.svg b/images/cpu_third_step.svg → src/images/cpu_third_step.svg
diff --git a/implementation/README.md → src/implementation/README.md b/implementation/README.md → src/implementation/README.md
diff --git a/intro/README.md → src/intro/README.md b/intro/README.md → src/intro/README.md
diff --git a/naming/README.md → src/naming/README.md b/naming/README.md → src/naming/README.md
diff --git a/u-root/README.md → src/u-root/README.md b/u-root/README.md → src/u-root/README.md
diff --git a/utilities/README.md → src/utilities/README.md b/utilities/README.md → src/utilities/README.md