added How to to readme

Legion2 · Nov 20, 2019 · 8f82df1 · 8f82df1
1 parent 4dcfa06
commit 8f82df1
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,36 @@
 # Corsair Lighting Protocol Boards
 Arduino boards definition for use with the CorsairLightingProtocol library.
+
+## How to use these boards in Arduino
+All boards can simply be installed in Arduino IDE via the Boards Manager.
+
+package index URL:
+```
+https://raw.githubusercontent.com/Legion2/CorsairLightingProtocolBoards/master/package_Legion2_CorsairLightingProtocolBoards_index.json
+```
+
+1. Open the **Preferences** of the Arduino IDE.
+
+   ![File->Preferences](images/open-preferences.png)
+1. Add the package index URL above in the **Additional Boards Manager URLs** field, and click OK.
+
+   ![Additional Boards Manager URLs Pop-up](images/add-package-url.png)
+1. Open the **Boards Manager** by opening the menu Tools->Board->Board Manager...
+
+   ![Tools->Board->Board Manager...](images/open-boards-manager.png)
+1. Search and install **Corsair Lighting Protocol Boards**
+
+   ![install boards in Board Manager](images/install-boards.png)
+1. Select one of the boards under Corsair Lighting Protocol Boards in Tools->Board menu
+
+   ![Tools->Board menu](images/select-board.png)
+1. Select one of the devices from corsair under Tools->Device
+
+   ![Tools->Device](images/select-device.png)
+1. Select COM port under Tools->Port
+
+   ![Tools->Port](images/select-port.png)
+1. Compile/Upload as usual
+
+## License
+This project is licensed under the Apache License Version 2.0.
diff --git a/images/add-package-url.png b/images/add-package-url.png
diff --git a/images/install-boards.png b/images/install-boards.png
diff --git a/images/open-boards-manager.png b/images/open-boards-manager.png
diff --git a/images/open-preferences.png b/images/open-preferences.png
diff --git a/images/select-board.png b/images/select-board.png
diff --git a/images/select-device.png b/images/select-device.png
diff --git a/images/select-port.png b/images/select-port.png