Commit c75e3d48 authored by Adam Procter's avatar Adam Procter
Browse files

Added basic guide on install

added in details to run install and dev scripts with pointers on installing coffee-script (I think it's needed) and backing up if an alpha participant.
parent be165bdd
......@@ -97,6 +97,29 @@ When in doubt, stick to the formatting you see elsewhere in the source. If you s
*‘Debugging is twice as hard as writing the code in the first place. Therefore, if you write the code as cleverly as possible, you are, by definition, not smart enough to debug it.’*
## Basic Install
Once you have cloned the repository you need to run the ./install and ./dev commands before you can build the Heartbeat XCode project. You may also need to install coffee-script. This is all done via terminal.
Then run the standard install as follows;
sudo ./install
sudo ./dev
If you come across the error when running ./install;
line 13: coffee: command not found
You will need to install coffee-script as follows;
sudo npm -g install coffee-script
Please note before you build in XCode, if you are part of the alpha team and building on the same Mac you should make sure you back up your container found at
Please back up this folder before testing so you can have one sandbox for local testing and one for your main account. You don't want to corrupt your alpha account.
## Common issues and troubleshooting
### App crashes after repeatedly getting errors that Pulse has crashed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment