From c67490c216eadd71322fd51702e4a0a58845f6f2 Mon Sep 17 00:00:00 2001
From: Gale Faraday <k4mu1kazum4@gmail.com>
Date: Thu, 21 Nov 2024 18:31:51 -0600
Subject: [PATCH] doc: sane outline for docs and how to build the firmware.

---
 code/boot/.editorconfig |  2 ++
 code/boot/README.md     | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 34 insertions(+)
 create mode 100644 code/boot/README.md

diff --git a/code/boot/.editorconfig b/code/boot/.editorconfig
index 6ffe7b0..d657257 100644
--- a/code/boot/.editorconfig
+++ b/code/boot/.editorconfig
@@ -13,6 +13,8 @@ indent_style = space
 indent_size = 2
 
 [*.md]
+indent_style = space
+indent_size = 2
 max_line_length = 80
 
 [makefile]
diff --git a/code/boot/README.md b/code/boot/README.md
new file mode 100644
index 0000000..a23b64c
--- /dev/null
+++ b/code/boot/README.md
@@ -0,0 +1,32 @@
+# Boot Firmware for CHIBI PC-09
+
+TODO: Description of what the firmware does for the PC-09.
+
+## Building the Firmware
+
+You will need GNU `make`, and [`asm6809`](https://www.6809.org.uk/asm6809) to
+build the firmware. Obtaining a working copy of `asm6809` could be difficult if
+you aren't on Debian, Ubuntu, or Windows as instructions for building it are not
+given on the `asm6809` website. Functional instructions for building from Git or
+tarball are given here:
+
+```sh
+git clone https://www.6809.org.uk/git/asm6809.git
+cd asm6809
+./configure
+make
+sudo make install
+```
+
+From there all you should have to do to generate a `boot.bin` is:
+
+```sh
+git clone https://github.com/amberisvibin/chibi-pc09.git
+cd chibi-pc09
+make
+```
+
+## Firmware Licensing
+
+This firmware like the rest of the CHIBI PC-09 is licensed under the MIT
+license.