From 0019e6a732a580329e342f57963ab19ce0b0c4cc Mon Sep 17 00:00:00 2001 From: Andre Richter Date: Mon, 21 Oct 2019 21:35:16 +0200 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8800e0c5..be378b10 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Operating System development tutorials in Rust on the Raspberry Pi 3 +# Operating System development tutorials in Rust on the Raspberry Pi ## Notice @@ -6,11 +6,14 @@ code and minimal READMEs, and later write accompanying full-fledged tutorial text.** +- The code written in these tutorials supports and runs on the **Raspberry Pi 3** and the **Raspberry Pi 4**. + - Tutorials 1 till 5 are groundwork code which only makes sense to on QEMU. + - Starting with [tutorial 6](06_drivers_gpio_uart), you can load and run the kernel on Raspberrys and observe output over UART. +- For practical purposes, the kernel will be a classic [monolith]. +- For editing, I recommend [Visual Studio Code] with the [Rust Language Server] extension. - Check out the `make doc` command to browse the code with HTML goodness. - Note that the branch is subject to frequent force pushing. If updates happened since you last visited, make sure to clone a clean copy to be safe. -- For editing, I recommend [Visual Studio Code] with the [Rust Language Server] extension. -- For practical purposes, the kernel will be a classic [monolith]. _Cheers, [Andre](https://github.com/andre-richter)_ @@ -35,11 +38,14 @@ cargo install cargo-xbuild cargo-binutils ## USB Serial -I'd also recommend to get an [USB serial debug -cable](https://www.adafruit.com/product/954). You connect it to the GPIO pins -14/15. +It is highly recommended to get a USB serial debug cable. It also powers the Raspberry once you +connect it, so you don't need extra power over the dedicated power-USB. I use a bunch of +[these](https://www.amazon.de/dp/B0757FQ5CX/ref=cm_sw_r_tw_dp_U_x_ozGRDbVTJAG4Q). + +You connect it to the GPIO pins 14/15 as shown beyond. -[Tutorial 6](06_drivers_gpio_uart) is the first where you can use it. Earlier tutorials will work solely with `QEMU`. +[Tutorial 6](06_drivers_gpio_uart) is the first where you can use it. Go to the README there +for instructions on how to prepare the SD card to run your self-made kernels from it. ![UART wiring diagram](doc/wiring.png)