From e9322dfc3480273c9bc24b9e7bbee296a981e818 Mon Sep 17 00:00:00 2001
From: BinHong Lee <binhong@binhong.me>
Date: Fri, 21 Apr 2017 09:32:03 -0700
Subject: [PATCH] Added README.md

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..48653af
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# Bike Safety with Pi
+
+A raspberry pi to be mounted on a bike to alert surrounding and the emergency contact of the rider if they fall.
+
+## Hardware requirements
+
+| Required | What I used |
+|------|-----|
+| Raspberry Pi | Pi 3 Model B |
+| MPU3050 gyroscope | OSEPP GYROS-01 |
+| Button interrupt | OSEPP PUSH-01 |
+| Buzzer |
+
+## Code dependencies
+
+1. g++
+2. ssmtp
+3. [wiringPi](http://wiringpi.com/download-and-install/)
+
+## Setup
+
+1. If you don't have ssmtp installed, run this
+  ```sh
+  $ sudo apt-get update && apt-get install ssmtp
+  ```
+2. Run the setup script
+  ```sh
+  $ ./setup.sh
+  ```
+3. Input the email you want to sent to
+4. Done!
+
+## Usage
+
+```
+$ ./compileandexecute.sh
+```