Added some docs.

MickMake · Apr 11, 2018 · e9c7b43 · e9c7b43
1 parent 2edcc7e
commit e9c7b43
Show file tree

Hide file tree

Showing 15 changed files with 48 additions and 1 deletion.
diff --git a/ArduinoIDE/README.md b/ArduinoIDE/README.md
@@ -0,0 +1,47 @@
+
+![MickMake](https://www.mickmake.com/banner.png)
+
+
+# Project - Super Duper
+This dir contains Arduino IDE board support for the Super Duper.
+
+
+## Quick start
+
+### 1. Run the Arduino IDE
+Fire up the Arduino IDE.
+![ScreenShot01.png](docs/ScreenShot01.png)
+
+
+### 2. Additional Boards Manager URLs
+Go to File -> Preferences
+![ScreenShot02.png](docs/ScreenShot02.png)
+
+In the section marked `Additional Boards Manager URLs` ...
+![ScreenShot03.png](docs/ScreenShot03.png)
+
+Add the following entry: `https://www.mickmake.com/SuperDuper/package_mickmake_index.json` and click OK.
+![ScreenShot04.png](docs/ScreenShot04.png)
+
+Under Tools -> Board -> Boards Manager
+![ScreenShot05.png](docs/ScreenShot05.png)
+![ScreenShot06.png](docs/ScreenShot06.png)
+
+Enter in `MickMake` into the search field.
+![ScreenShot07.png](docs/ScreenShot07.png)
+![ScreenShot08.png](docs/ScreenShot08.png)
+
+Select the package, and then click on `Install`
+![ScreenShot09.png](docs/ScreenShot09.png)
+![ScreenShot10.png](docs/ScreenShot10.png)
+
+Then click OK when finished.
+![ScreenShot11.png](docs/ScreenShot11.png)
+
+Go back to Tools -> Board -> Boards Manager and scroll down to select the Super Duper Board.
+![ScreenShot05.png](docs/ScreenShot05.png)
+![ScreenShot12.png](docs/ScreenShot12.png)
+
+Go back to Tools and check that it has been selected.
+![ScreenShot13.png](docs/ScreenShot13.png)
+
diff --git a/ArduinoIDE/docs/ScreenShot01.png b/ArduinoIDE/docs/ScreenShot01.png
diff --git a/ArduinoIDE/docs/ScreenShot02.png b/ArduinoIDE/docs/ScreenShot02.png
diff --git a/ArduinoIDE/docs/ScreenShot03.png b/ArduinoIDE/docs/ScreenShot03.png
diff --git a/ArduinoIDE/docs/ScreenShot04.png b/ArduinoIDE/docs/ScreenShot04.png
diff --git a/ArduinoIDE/docs/ScreenShot05.png b/ArduinoIDE/docs/ScreenShot05.png
diff --git a/ArduinoIDE/docs/ScreenShot06.png b/ArduinoIDE/docs/ScreenShot06.png
diff --git a/ArduinoIDE/docs/ScreenShot07.png b/ArduinoIDE/docs/ScreenShot07.png
diff --git a/ArduinoIDE/docs/ScreenShot08.png b/ArduinoIDE/docs/ScreenShot08.png
diff --git a/ArduinoIDE/docs/ScreenShot09.png b/ArduinoIDE/docs/ScreenShot09.png
diff --git a/ArduinoIDE/docs/ScreenShot10.png b/ArduinoIDE/docs/ScreenShot10.png
diff --git a/ArduinoIDE/docs/ScreenShot11.png b/ArduinoIDE/docs/ScreenShot11.png
diff --git a/ArduinoIDE/docs/ScreenShot12.png b/ArduinoIDE/docs/ScreenShot12.png
diff --git a/ArduinoIDE/docs/ScreenShot13.png b/ArduinoIDE/docs/ScreenShot13.png
diff --git a/README.md b/README.md
@@ -17,6 +17,6 @@ This is currently in alpha state and is a WIP.
 
 
 ## Directories
-`ArduinoIDE` - Full board support for the Arduino IDE. Currently implements basic GPIOs, SPI ports, LEDs, but no functional API yet.
+`ArduinoIDE/` - Full board support for the Arduino IDE. Currently implements basic GPIOs, SPI ports, LEDs, but no functional API yet.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,6 +17,6 @@ This is currently in alpha state and is a WIP.


		## Directories
		`ArduinoIDE` - Full board support for the Arduino IDE. Currently implements basic GPIOs, SPI ports, LEDs, but no functional API yet.
		`ArduinoIDE/` - Full board support for the Arduino IDE. Currently implements basic GPIOs, SPI ports, LEDs, but no functional API yet.