From 778a452425663e7f67eceb31fc32c6ae2470e643 Mon Sep 17 00:00:00 2001
From: occheung <dc@m-labs.hk>
Date: Fri, 7 Aug 2020 13:04:39 +0800
Subject: [PATCH] readme: init

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..03801a9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# Firmware development
+
+RF signal generator using Urukul, Humpback and STM32
+
+## Nix commands
+
+Open nix shell before anything.
+```bash
+nix-shell
+```
+
+Start OpenOCD server in unblocking mode.
+```bash
+run-openocd
+```
+
+Start OpenOCD server in blocking mode, for console print through semihosting.
+```bash
+run-openocd-block
+```
+
+Reset STM32 flash before flashing bitstream for Humpback FPGA.
+```bash
+reset-flash
+```
+
+Load bitstream to Humpback FPGA.
+```bash
+configure-fpga
+```
+
+Verify a proper bitstream is loaded to STM32 flash.
+```bash
+verify-fpga-config
+```
+
+Run a Ethernet server with TCP socket examples.
+```bash
+run-ethernet-server
+```
+
+Select a different gdb config file from ```gdb_config``` directory.
+```bash
+set-gdb-config-file <filename>
+```
+Leave <filename> as blank for default openocd.gdb configuration.