From 16b0af5482a3dbe6e50fd87719c29c225e66665b Mon Sep 17 00:00:00 2001
From: armink <armink.ztl@gmail.com>
Date: Fri, 26 Jun 2020 23:01:12 +0800
Subject: [PATCH] [demo][stm32f405rg] add readme.

---
 demos/stm32f405rg/README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 demos/stm32f405rg/README.md

diff --git a/demos/stm32f405rg/README.md b/demos/stm32f405rg/README.md
new file mode 100644
index 0000000..8ec2497
--- /dev/null
+++ b/demos/stm32f405rg/README.md
@@ -0,0 +1,35 @@
+# stm32f405rg on-chip flash demo
+
+## What
+
+KVDB  and TSDB demo on STM32F4X chip
+
+- MCU: STM32F405RG
+- Flash Driver
+  - STM32 on-chip flash
+- IO
+  - UART
+    - TXD: PA9
+    - RXD: PA10
+
+## How
+
+### Step1: connect the serial terminal
+
+Connect the board to PC by serial port and open the PC serial terminal.
+
+### Step2: open demo project
+
+support 2 kinds of IDEs
+
+- Keil MDK: open `RVMDK\FlashDB.uvprojx`
+- [RT-Thread Studio](https://www.rt-thread.io/studio.html): import this folder by import wizard
+
+### Step3: build and download
+
+Download the firmware to your board when build successful.
+
+### Step4: check the log
+
+This demo's log will output to PC serial.
+