From 7ca087a35461c203ea4c632244e683a6cd8ab164 Mon Sep 17 00:00:00 2001
From: Mathieu Maret <mathieu.maret@gmail.com>
Date: Sun, 1 May 2022 23:06:12 +0200
Subject: [PATCH] Add Readme

---
 Readme.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..343d1d4
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,34 @@
+# A raspberry 3 OS
+
+Support:
+1. UART
+2. Framebuffer
+3. update over serial
+4. Qemu
+
+## UART
+Using GPIO 14 and 15
+
+## update over serial
+
+You can update a kernel that is connected a given TTY with
+`TTY=/dev/MYTTY make update_serial`
+
+This is mainly usefull for kernel running on a real board but to use it with QEMU, you have to modify the serial opt to be
+`-serial pty`
+
+and then
+`TTY=/TTY_VERBOSED_BY_QEMU make update_serial`
+
+## QEMU
+
+You can test it with
+` make run`
+
+### Qemu with a debugger
+
+`make debug`
+
+# Install on sdcard
+
+Create a FAT32 partion and copy kernel and kernel8.img