From 1628edad625b0553c0194fc148ab440c2f20f496 Mon Sep 17 00:00:00 2001 From: saji Date: Thu, 23 May 2024 12:07:53 -0500 Subject: [PATCH] add basic mdbook doc --- doc/.gitignore | 1 + doc/.gitkeep | 0 doc/book.toml | 6 ++++++ doc/src/SUMMARY.md | 6 ++++++ doc/src/chapter_1.md | 1 + flake.nix | 1 + 6 files changed, 15 insertions(+) create mode 100644 doc/.gitignore create mode 100644 doc/.gitkeep create mode 100644 doc/book.toml create mode 100644 doc/src/SUMMARY.md create mode 100644 doc/src/chapter_1.md diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..7585238 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1 @@ +book diff --git a/doc/.gitkeep b/doc/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/book.toml b/doc/book.toml new file mode 100644 index 0000000..ba32a95 --- /dev/null +++ b/doc/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Saji Champlin"] +language = "en" +multilingual = false +src = "src" +title = "Groovylight" diff --git a/doc/src/SUMMARY.md b/doc/src/SUMMARY.md new file mode 100644 index 0000000..7a06940 --- /dev/null +++ b/doc/src/SUMMARY.md @@ -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) diff --git a/doc/src/chapter_1.md b/doc/src/chapter_1.md new file mode 100644 index 0000000..b743fda --- /dev/null +++ b/doc/src/chapter_1.md @@ -0,0 +1 @@ +# Chapter 1 diff --git a/flake.nix b/flake.nix index c33df90..2284b99 100644 --- a/flake.nix +++ b/flake.nix @@ -62,6 +62,7 @@ # for building the simulator cmake ninja + mdbook ]; }; });