add basic mdbook doc
Some checks failed
Verilator Unit Tests / Test (push) Failing after 5m23s

This commit is contained in:
saji 2024-05-23 12:07:53 -05:00
parent 37b813a015
commit 1628edad62
6 changed files with 15 additions and 0 deletions

1
doc/.gitignore vendored Normal file
View file

@ -0,0 +1 @@
book

0
doc/.gitkeep Normal file
View file

6
doc/book.toml Normal file
View file

@ -0,0 +1,6 @@
[book]
authors = ["Saji Champlin"]
language = "en"
multilingual = false
src = "src"
title = "Groovylight"

6
doc/src/SUMMARY.md Normal file
View file

@ -0,0 +1,6 @@
# Summary
- [Insert Coin](./ch1_insert_coin.md) an introduction to modern retro gaming experiences.
- [Background](./ch2-background.md) explains the rationale behind this project.
- [Getting Started](./get-started.md) everything you need to play games
- [Going further](./going-further)

1
doc/src/chapter_1.md Normal file
View file

@ -0,0 +1 @@
# Chapter 1

View file

@ -62,6 +62,7 @@
# for building the simulator # for building the simulator
cmake cmake
ninja ninja
mdbook
]; ];
}; };
}); });