From 308becd3801413c1932e43c2b9201f04dbc1144e Mon Sep 17 00:00:00 2001
From: Lleyton Gray <lleyton@fyralabs.com>
Date: Tue, 5 Dec 2023 01:17:58 -0800
Subject: [PATCH 1/2] docs: "fancified" readme

---
 README    | 13 -------------
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 52 insertions(+), 13 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index d6408ef..0000000
--- a/README
+++ /dev/null
@@ -1,13 +0,0 @@
-experimental bootloader for depthcharge
-
-TODO:
-improve makefile
-make u-root and linux git submodules
-automatic github actions builds
-
-how to build:
-clone u-root
-clone linux, put source in kernel/
-copy kernel.config to kernel/.config
-make -j$(nproc)
-flash build/crboot.kpart to your drive
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aaf4395
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+<!-- <img align="left" style="vertical-align: middle" width="120" height="120" alt="Skiff Icon" src="data/icons/app.svg"> -->
+
+# cr-boot
+
+An experimental bootloader for depthcharge.
+
+###
+
+<!-- [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) -->
+
+## 🛠️ Dependencies
+
+Please make sure you have these dependencies first before building.
+
+```bash
+make
+gcc
+flex
+bison
+elfutils-devel
+parted
+vboot-utils
+golang
+xz
+bc
+```
+
+Additionally, you'll need to install u-root. To install the latest version:
+
+```bash
+go install github.com/u-root/u-root@latest
+```
+
+## 🏗️ Building
+
+Simply clone this repo, with submodules, so pass `--recurse-submodules` to `git clone`, then:
+
+```bash
+make -j$(nproc)
+```
+
+The build output is located in `build/`.
+For testing, an image is built at `build/crboot.bin` which you can directly flash onto an external drive.
+Here's an example, replace `/dev/sda` with the device file of the external drive:
+
+```bash
+sudo dd if=build/crboot.bin of=/dev/sda
+```
+
+## 🗒️ Todos
+
+- improve makefile

From a6f0e04f4c2c22bccd1189630728a4ed6cd80b9e Mon Sep 17 00:00:00 2001
From: Lleyton Gray <lleyton@fyralabs.com>
Date: Tue, 5 Dec 2023 01:28:54 -0800
Subject: [PATCH 2/2] docs: add builds section

---
 README.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index aaf4395..caf5289 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,12 @@ An experimental bootloader for depthcharge.
 
 <!-- [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) -->
 
+## 📦 Builds
+
+We offer prebuilt versions of the images per each commit:
+
+- [Latest build](https://github.com/FyraLabs/cr-boot/blob/main/.github/workflows/build.yml)
+
 ## 🛠️ Dependencies
 
 Please make sure you have these dependencies first before building.
@@ -33,7 +39,7 @@ go install github.com/u-root/u-root@latest
 
 ## 🏗️ Building
 
-Simply clone this repo, with submodules, so pass `--recurse-submodules` to `git clone`, then:
+Simply clone this repo with submodules, so pass `--recurse-submodules` to `git clone`, then:
 
 ```bash
 make -j$(nproc)
@@ -41,7 +47,7 @@ make -j$(nproc)
 
 The build output is located in `build/`.
 For testing, an image is built at `build/crboot.bin` which you can directly flash onto an external drive.
-Here's an example, replace `/dev/sda` with the device file of the external drive:
+So, for example, replace `/dev/sda` with the device file of the external drive:
 
 ```bash
 sudo dd if=build/crboot.bin of=/dev/sda