diff --git a/docs/README.md b/docs/README.md index 5b9a3b34..0b82ab6f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,7 +8,8 @@ XOD Documentation Tutorials --------- -* [Installing and Running XOD](./tutorial/install/) +* [Installing and running XOD](./tutorial/install/) +* [Required hardware](./tutorial/required-hardware/) 1. [Hello](./tutorial/01-hello) 2. [Upload to Arduino](./tutorial/02-deploy) @@ -31,7 +32,7 @@ Tutorials 19. [If-else branching](./tutorial/19-if-else) 20. [Smoother changes](./tutorial/20-fade) -* [Complex Projects?](./tutorial/complex-projects/) +* [Complex projects?](./tutorial/complex-projects/) ### Contributed tutorials diff --git a/docs/tutorial/README.md b/docs/tutorial/README.md index fc37b6ab..7b01ec64 100644 --- a/docs/tutorial/README.md +++ b/docs/tutorial/README.md @@ -5,7 +5,8 @@ title: Tutorials Tutorials ========= -* [Installing and Running XOD](./install/) +* [Installing and running XOD](./install/) +* [Required hardware](./required-hardware/) 1. [Hello](./01-hello) 2. [Upload to Arduino](./02-deploy) @@ -28,7 +29,7 @@ Tutorials 19. [If-else branching](./19-if-else) 20. [Smoother changes](./20-fade) -* [Complex Projects?](./complex-projects/) +* [Complex projects?](./complex-projects/) ### Contributed tutorials diff --git a/docs/tutorial/install/README.md b/docs/tutorial/install/README.md index c7414be6..0755f13b 100644 --- a/docs/tutorial/install/README.md +++ b/docs/tutorial/install/README.md @@ -32,9 +32,10 @@ Windows, macOS, and Linux. Find a distribution package for your system on What’s next ----------- -Once you start XOD IDE, you’ll see the `welcome-to-xod` project open. It’s -a tutorial project split on many small lessons. Follow instuctions in its -comments to learn XOD. +Once you start XOD IDE, you’ll see the `welcome-to-xod` project open. It’s a +tutorial project split on many small lessons. Follow instuctions in its +comments to learn XOD. There is a [web version of the tutorial](../01-hello/) +if you just want to get shallow understanding. -There is a [web version of the tutorial](../01-hello/) if you just want to get -shallow understanding. +You’ll need some hardware components to compete the tutorial, here is the +[list of parts](../required-hardware/). diff --git a/docs/tutorial/required-hardware/README.md b/docs/tutorial/required-hardware/README.md new file mode 100644 index 00000000..0cb41646 --- /dev/null +++ b/docs/tutorial/required-hardware/README.md @@ -0,0 +1,34 @@ +--- +title: Required Hardware +--- + +# Required Hardware + +XOD is not tied to a particular vendor of hardware. It is compatible with +various controller boards, sensors, and peripherals devices that can be +programmed with Arduino IDE. + +Nevertheless, for the best experience with this tutorial we recommend you +using [SparkFun Inventor Kit](https://www.sparkfun.com/products/14189?utm_source=xodio&utm_medium=xod&utm_campaign=tutorial) +because it contains all the components you’ll need to complete the lessons. + +[![SIK](./sik.jpg)](https://www.sparkfun.com/products/14189?utm_source=xodio&utm_medium=xod&utm_campaign=tutorial) + +## Components you’ll need + +* 1× Arduino (or compatible) board +* 1× USB cable +* 1× Breadboard +* 2× LED +* 1× TMP36 temperature sensor +* 1× Servo +* 2× Tactile buttons +* 1× Photoresistor (aka LDR) +* 1× Potentiometer +* 2× 220 or 330Ω resistors +* 3× 10kΩ resistors +* Jumper wires + +## Ready? + +Go to the [first lesson →](../01-hello) diff --git a/docs/tutorial/required-hardware/sik.jpg b/docs/tutorial/required-hardware/sik.jpg new file mode 100644 index 00000000..b60338a2 Binary files /dev/null and b/docs/tutorial/required-hardware/sik.jpg differ