From 05d86fc6cee21dfbfd20684d24bb9dd5cfac4a7f Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Thu, 17 Oct 2024 15:08:32 -0700
Subject: [PATCH] Update fpga README formatting

---
 fpga/README.md | 52 ++++++++++++++++++++++++++++++++------------------
 1 file changed, 33 insertions(+), 19 deletions(-)

diff --git a/fpga/README.md b/fpga/README.md
index 236bc7ddb..249df565b 100644
--- a/fpga/README.md
+++ b/fpga/README.md
@@ -6,29 +6,39 @@ Wally supports the following boards
 
 # Quick Start
 
-## build FPGA
+## Build FPGA
 
-`cd generator
-make <board name>`
+```bash
+cd generator
+make <board name>
+```
 
-example
-`make vcu108`
+Example:
+```bash
+make vcu108
+```
 
 ## Make flash card image
-ls /dev/sd* or ls /dev/mmc* to see which flash card devices you have.
-Insert the flash card into the reader and ls /dev/sd* or /dev/mmc* again.  The new device is the one you want to use.  Make sure you select the root device (i.e. /dev/sdb) not the partition (i.e. /dev/sdb1).
+`ls /dev/sd*` or `ls /dev/mmc*` to see which flash card devices you have.
+Insert the flash card into the reader and `ls /dev/sd*` or `/dev/mmc*` again.  The new device is the one you want to use.  Make sure you select the root device (i.e. `/dev/sdb`) not the partition (i.e. `/dev/sdb1`).
 
-`cd $WALLY/linux/sd-card`
+```bash
+cd $WALLY/linux/sd-card
+```
 
 This following script requires root.
 
-`./flash-sd.sh -b <path to buildroot> -d <path to compiled device tree file> <flash card device>`
+```bash
+./flash-sd.sh -b <path to buildroot> -d <path to compiled device tree file> <flash card device>
+```
 
-example with vcu108, buildroot installed to /opt/riscv/buildroot, and the flash card is device /dev/sdc
+Example with vcu108, buildroot installed to `/opt/riscv/buildroot`, and the flash card is device `/dev/sdc`
 
-`./flash-sd.sh -b /opt/riscv/buildroot -d /opt/riscv/buildroot/output/images/wally-vcu108.dtb /dev/sdc`
+```bash
+./flash-sd.sh -b /opt/riscv/buildroot -d /opt/riscv/buildroot/output/images/wally-vcu108.dtb /dev/sdc
+```
 
-Wait until the the script completes then remove the car.
+Wait until the the script completes then remove the card.
 
 ## FPGA setup
 
@@ -36,22 +46,26 @@ For the Arty A7 insert the PMOD daughter board into the right most slot and inse
 
 For the VCU108 and VCU118 boards insert the PMOD daughter board into the only PMOD slot on the right side of the boards.
 
-Power on the boards. Arty A7 just plug in the USB connector. For the VCU boards make sure the power supply is connected and the two usb cables are connected. Flip on the switch.
+Power on the boards. For Arty A7 just plug in the USB connector. For the VCU boards make sure the power supply is connected and the two usb cables are connected. Flip on the switch.
 The VCU118's on board UART converter does not work. Use a spark fun FTDI usb to UART adapter and plug into the mail PMOD on the right side of the board.  Also the level sifters on the
 VCU118 do not work correctly with the digilent sd PMOD board.  We have a custom board which works instead.
 
-`cd $WALLY/fpga/generator
-vivado &`
+```bash
+cd $WALLY/fpga/generator
+vivado &
+```
 
-open the design in the current directory WallyFPGA.xpr.
+Open the design in the current directory `WallyFPGA.xpr`.
 
 Then click "Open Target" under "PROGRAM AND DEBUG".  Then Program the device.
 
 ## Connect to UART
 
-In another terminal ls /dev/ttyUSB*. One of these devices will be the UART connected to Wally. You may have to experiment by the running the following command multiple times.
+In another terminal `ls /dev/ttyUSB*`. One of these devices will be the UART connected to Wally. You may have to experiment by the running the following command multiple times.
 
-`screen /dev/ttyUSB1 115200`
+```bash
+screen /dev/ttyUSB1 115200
+```
 
-Swap out the USB1 for USB0 or USB1 as needed.
+Swap out the `USB1` for `USB0` or `USB1` as needed.