diff --git a/README.md b/README.md index 1736466..efc634b 100644 --- a/README.md +++ b/README.md @@ -6,23 +6,23 @@ Built an Alexa App which lives in the Mac System Tray. It can be accessed at any Big Shoutout to [Carson McDonald](https://github.com/carsonmcdonald) whose [AVSExample](https://github.com/carsonmcdonald/AVSExample-Swift) in Swift laid the foundation for this project. ___ -##Benefits of this app vs the Amazon Echo +## Benefits of this app vs the Amazon Echo 1. You can do client side processing on the Audio (i.e: determine who is speaking, get sentiment or emotion analysis...etc) 2. It's much easier for demoing the Amazon skill you just created at a Hackathon 3. It's Free! ;) --- -##Getting Started -###Just want the Binary? +## Getting Started +### Just want the Binary? Skip all the instructions below. Clone the repo and run the app in the Binary Folder. I believe you still [need an Alexa account](alexa.amazon.com). -###Amazon Developer Account +### Amazon Developer Account 1. Create an account at developer.amazon.com 2. Follow the [getting started guide](https://developer.amazon.com/appsandservices/solutions/alexa/alexa-voice-service/getting-started-with-the-alexa-voice-service) for Amazon Voice Service. 3. In the procedure keep track of your Application Type ID and Client ID. We will need those values later. -###Install Dependencies +### Install Dependencies [Carthage](https://github.com/Carthage/Carthage) is used for dependancies. After cloning go into the root directory and run: ``` @@ -30,14 +30,14 @@ carthage bootstrap ``` Since this is Carthage, make sure to add the GCDframework for Mac OSX to the project after your done running the bootstrap command. -###Enter Config Values +### Enter Config Values ![Alt text](http://i.imgur.com/gjoth5j.png "MacLexa System Tray") - Click on the MacLexa icon to show the Nib. - Enter in the Application Type ID and Client ID - Register -###Begin! +### Begin! ![Alt text](http://i.imgur.com/D3aVC6j.png "MacLexa Recording in the System Tray") - Press the Option Key to start recording, on first press it will see you dont have a token and open up a safari window for you to enter your amazon creds - Hold and Press the option key while you're talking to Alexa. You will see a red record icon pop up become visible while you are speaking to alexa.