Added documentations and instructions to set up

README.md

@@ -0,0 +1,46 @@
+# AVR - Sunrise Alarm Clock
+
+The program is written for an ATMEGA168 programmed through an AVR.
+
+**For a comprehensive guide (or hardware side tutorial), please go to [https://binhonglee.github.io/AVR---Sunrise-Alarm-Clock](https://binhonglee.github.io/AVR---Sunrise-Alarm-Clock)**
+
+### Requirements
+
+This program requires the following stuffs to work on your computer:
+- avrdude
+- make
+- cmake
+- UART terminal
+
+### Installation
+
+1. Clone this repository
+```sh
+$ git clone https://github.com/binhonglee/AVR---Sunrise-Alarm-Clock/
+```
+
+2. (Optional) Check the Makefile to see if it fits your microcontroller and controller.
+
+3. Open your UART terminal.
+
+4. Make sure your UART terminal is connected to your USART component.
+
+5. Flash the microcontroller
+```sh
+$ make flash
+```
+
+### Removal
+
+To remove this program from your computer, do the following:
+
+1. Uninstall every other thing you installed from the requirements that you no longer need.
+
+2. Delete this folder
+```sh
+$ cd ../
+$ rm -rf AVR---Sunrise-Alarm-Clock
+```
+
+###### Author's note :
+Most of the program has line by line comments written so it shouldn't be too hard to understand and to tweak it for your use.

index.md

@@ -0,0 +1,38 @@
+# AVR - Sunrise Alarm Clock
+
+This documentation is written around an ATMEGA168 programmed through an AVR. It might (should) be compatible with other microcontrollers but you will need to tweak the program and the set up a little bit here and there.
+
+**For software side installation instruction, please go to [https://github.com/binhonglee/AVR---Sunrise-Alarm-Clock](https://github.com/binhonglee/AVR---Sunrise-Alarm-Clock)**
+
+### Requirements
+
+The parts that is used in building the project includes:
+- [ATMEGA168](http://www.atmel.com/devices/ATMEGA168.aspx)
+- Long breadboard
+- Active Buzzer
+- Photoresistor
+- Button Interrupt
+- 100uF 50V capacitor
+- Resistor
+- [USBtinyISP](https://learn.adafruit.com/usbtinyisp) - AVR programmer & SPI interface
+- UART serial port
+- Bunch of wires
+
+Optional:
+- LED
+- Additional Resistor
+
+### Putting it together
+
+1. Solder your USBtinyISP according to the tutorial.
+
+2. Put all the parts onto the breadboard according to this diagram. (If you do not have any LEDs or Resistors, ignore them)
+![image](./diagram.png)
+
+3. Connect everything together onto your computer.
+
+4. (Optional) If you have the LEDs and Resistors connected, make sure the LEDs is lightened up.
+
+5. Proceed to flash the microcontroller with the program following the instructions [here](https://github.com/binhonglee/AVR---Sunrise-Alarm-Clock).
+
+6. Congratulations, you have it all put together!