added install guide to readme

a2198699s · Apr 20, 2020 · 3181e6c · 3181e6c
1 parent 97efc12
commit 3181e6c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,13 @@
 A Raspberry Pi real-time pitch-shifting microphone project.
 Stay Tuned...
 
+## Install Guide
+
+Clone and cd into pitch-perfector
+1. `cmake .`
+2. `make`
+3. `./Code/fft_object/PitchPerfector`
+
 ## System Overview
 
 The **MEMS microphone** converts the vocal (from ~100Hz up to ~3.5kHz) input into an analoge signal