From 403e61d90a88cd7def611bd83a27c6fa07135274 Mon Sep 17 00:00:00 2001
From: UT2UH <oles@yaremenko.ws>
Date: Mon, 2 Nov 2020 21:12:39 +0200
Subject: [PATCH] Update README.md

---
 README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 58 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7084736..cd69a2d 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,29 @@
 Maixduino
 ========
 
-Arduino core for Maix Board (K210)
+# Arduino Core for K210 based devices
 
 
+
+## Supported devices
+
+### Sipeed Maix series
+  - [Amigo](https://dl.sipeed.com/MAIX/HDK/Sipeed-Amigo)
+  - [Cube](https://dl.sipeed.com/MAIX/HDK/Sipeed-Maix-Cube)
+  - [Go](https://dl.sipeed.com/MAIX/HDK/Sipeed-Maix-GO)
+  - [Maixduino](https://dl.sipeed.com/MAIX/HDK/Sipeed-Maixduino)
+  - [Dock](https://dl.sipeed.com/MAIX/HDK/Sipeed-Maix-Dock)
+  - [BiT](https://dl.sipeed.com/MAIX/HDK/Sipeed-Maix-Bit)
+  - [Nano](https://dl.sipeed.com/MAIX/HDK/Sipeed-Maix-Nano)
+
+### M5Stack
+ * [M5StickV](https://m5stack.com/products/stickv)
+ * [M5UnitV](https://m5stack.com/collections/m5-unit/products/unitv-ai-camera)
+
+### Various custom boards
+ * [LAMLOEI AOIT DAAN](https://github.com/lamloei/AIoTDaaN/tree/master/hardware/20190505-R2/AIoTDaaN_R2/pdf)
+ * [IOXGD4](https://github.com/ioxgd/IOXGD-hardware/tree/master/IOXGD4/pdf)
+
 ## Docs
 
 Docs: [maixduino.sipeed.com](https://maixduino.sipeed.com/)
@@ -12,10 +32,45 @@ Docs: [maixduino.sipeed.com](https://maixduino.sipeed.com/)
 
 Refer install doc: [Install](https://maixduino.sipeed.com/en/get_started/install.html)
 
+## Installing
 
-## Other SDK
+### From Board Manager
+
+ 1. [Download and install the Arduino IDE](https://www.arduino.cc/en/Main/Software) (at least version v1.9.8)
+ 2. Start the Arduino IDE
+ 3. Go into Preferences
+ 4. Add ```https://github.com/UT2UH/Maixduino/blob/gh-pages/package_Maixduino_boards_index.json``` as an "Additional Board Manager URL"
+ 5. Open the Boards Manager from the Tools -> Board menu and install "Maixduino(K210)"
+ 6. Select your K210 board from the Tools -> Board menu
+
+### From git
+
+ 1. Follow steps from Board Manager section above
+ 2. ```cd <SKETCHBOOK>```, where ```<SKETCHBOOK>``` is your Arduino Sketch folder:
+  * OS X: ```~/Documents/Arduino```
+  * Linux: ```~/Arduino```
+  * Windows: ```~/Documents/Arduino```
+ 3. Create a folder named ```hardware```, if it does not exist, and change directories to it
+ 4. Clone this repo: ```git clone https://github.com/UT2UH/Maixduino/tree/MAixCore Maixduino/k210```
+ 5. Restart the Arduino IDE
+
+### Firmware flashing
+The firmware of the K210 devices is updated with a Python-based [kflash](https://github.com/sipeed/kflash.py) cross-platform tool.
+Follow ```kflash``` github page on installation instruction.
+
+
+###### Change board settings in Tools section on the top of Arduino IDE
+
+ 1. Board: The same as your dev board
+ 2. Burn Toolfirmware: leave default, for Maix Go Kit - ```open-ec```
+ 3. Burn Baudrate: Decrease it if download fails
+ 4. Port: Serial port, e.g. ```/dev/ttyUSB0```
+ 5. Programmer: ```k-flash```
+
+## Credits
+
+This core is based on and compatible with the [Sipeed Maixduino Core](https://github.com/sipeed/Maixduino)
 
-If you want to code by scripts, refer to our [MaixPy](https://maixpy.sipeed.com)