readme

Author: gbr1

README.md

@@ -1,26 +1,42 @@
-# Install Micropython firmware
+# arduino-alvik-mpy
 
-_First Install mpremote_
+**Arduino Alvik micropython** library.
 
-mpremote is needed to upload files on the nano-ESP32.
 
-__DO NOT USE LAB FOR MICROPYTHON TO UPLOAD BIN FILES__
+
+<br>
+<br>
+
+
+
+## How to Install Micropython library
+
+### 1. install mpremote
+
+[mpremote](https://docs.micropython.org/en/latest/reference/mpremote.html) is needed to upload files on the [Arduino® Nano ESP32](https://store.arduino.cc/products/nano-esp32?gad_source=1&gclid=Cj0KCQiA2KitBhCIARIsAPPMEhLtIxV_s7KyLJO4-69RdR1UeFTdgGK_XmI8w7xdbur4gs1oJU4Jl68aAhbaEALw_wcB).
 
 ```shell
 (venv)$ pip install mpremote
 ```
 
-_Using scripts_
+### 2. install library
+
+Run `install.sh` (on Linux/MacOS) or `install.bat` (Windows) to upload all files needed to run the Arduino Alvik micropython library.
 
-Please run install.sh (on Linux) or install.bat (Windows) to upload all the files needed to run the robot MP firmware
+__NOTE: DO NOT USE LAB FOR MICROPYTHON TO UPLOAD BIN FILES__
 
-### Exmples
+<br>
+<br>
 
-_Upload the examples you need with mpremote_
+## Examples
+
+Use `mpremote` to copy files into your Arduino® Nano ESP32.
 
 e.g.
 ``` shell
 (venv)$ mpremote connect "COM1" fs cp ./examples/led_setting.py :led_setting.py
 ```
 
-You can now use Arduino Lab for Micropython to run your examples remotely from the device filesystem
+You can now use Arduino Lab for Micropython to run your examples remotely from the device filesystem.
+
+__Note: not open bin files with Arduino Lab for Micropython because they will be corrupted__