Tweaked the Arduino code in the writeup

[miniband.git] / README.md

diff --git a/README.md b/README.md
index aeb3cbcf2d9d7867213556cd7cd55f1ec71daf66..52e292afc72b36a336bcb907b849694f6150313f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,59 @@
-miniband
-========
\ No newline at end of file
+Code Club - Mini Band Project
+=============================
+
+<img src="http://farm9.staticflickr.com/8338/8256708023_4a941566e9.jpg" width="500" height="375" alt="photo (2)">
+
+Make your own mini band! 
+You and your friends can form your own finger-sized band and rock out using Raspberry Pi and Arduino. 
+Learn how to build circuits with sensors and outputs and write a simple programme to control your instruments.
+
+## Instructions
+
+The instructions are in the [writeup directory](https://github.com/NeilNjae/miniband/tree/master/writeup); you'll probably want the [instructions PDF](https://github.com/NeilNjae/miniband/tree/master/writeup/miniband.pdf). Code samples are in the [release directory](https://github.com/NeilNjae/miniband/tree/master/release).
+
+## You will make:
+
+* A guitar
+* A set of drums
+* A pair of maracas
+
+## You will need:
+
+* 1 x Raspberry Pi (plus monitor and power supply)
+* 1 x Arduino Uno boards (with USB cables)
+* 1 x strip potentiometer
+* 2 x tilt sensors
+* 4 x piezo buzzers (the type in greetings cards, easy to get from Maplin)
+* 7 × 10K resistors
+* Bread boards (1 per instrument)
+* Card
+* Sugru (or some other modelling material)
+* Electrical tape
+* Plastic drinking straw
+* Pencil
+* Coloured pens (optional)
+
+
+## Software requirements:
+
+* Scratch
+* IDE developer environment for Arduino
+* Py Serial library
+
+## Drum Kit
+
+<img src="http://farm9.staticflickr.com/8074/8257699966_7585ca06e7.jpg" width="375" height="500" alt="Code Club Miniband"><
+
+## Guitar
+
+<img src="http://farm9.staticflickr.com/8070/8257698984_8471e4cf57.jpg" width="500" height="375" alt="Code Club Miniband">
+
+## Maracas
+
+<img src="http://farm9.staticflickr.com/8346/8257698652_4a99ee24b4.jpg" width="500" height="375" alt="Code Club Miniband">
+
+
+## Useful links:
+
+* [Pictures from the hack day where this was put together](http://bit.ly/codeclubminiband) 
+* [Ardunio code](https://github.com/KatJoyWhite/miniband/tree/master/arduino)