Merge branch 'master' of github.com:bitgapp/eqMac

Author: nodeful

README.md

@@ -28,15 +28,51 @@ Idea is to become the ultimate Audio toolbox for macOS (some features might not
 * and more...
 
 ## User support
-I'm notoriously known for lacking in communication with users due to lack of time in my busy life. This project is heavily reliant on the whole community helping each other out. If you have an issue with eqMac please go through [Issues](https://github.com/bitgapp/eqMac/issues) to see if it's already being discussed, if not create a new one. Also you can [join our Discord](https://discord.gg/BA22ceW). Please no stupid questions like "How to bass?" - those will be completely ignored by myself.
+I'm notoriously known for lacking in communication with users due to lack of time in my busy life. This project is heavily reliant on the whole community helping each other out. If you have an issue with eqMac please go through [Issues](https://github.com/bitgapp/eqMac/issues) to see if it's already being discussed, if not create a new one. Also you can [join our Discord](https://discord.eqmac.app). Please no stupid questions like "How to bass?" - those will be completely ignored.
 
 ## Technology
 eqMac was built using these technologies:
 * [Driver](https://github.com/bitgapp/eqMac/tree/master/native/driver) - System Audio loopback/passthrough device based on [BackgroundMusic](https://github.com/kyleneideck/BackgroundMusic) project. The driver grabs the system audio stream and sends it to the input channels. eqMac can grab this stream, process it and send to the appropriate audio device. Still very low level C++ code although the driver runs in User space instead of Kernel like the previous drivers, which means it's much more secure and stable.
 * [App](https://github.com/bitgapp/eqMac/tree/master/native/app) - Native backend to the whole app. Responsible for audio processing, filesystem access, window management, API and general lifecycle of eqMac. Written in Swift and uses Apple's more modern [AVAudioEngine API](https://developer.apple.com/documentation/avfoundation/avaudioengine), unlike the previous version that used a deprecated AUGraph API.
-* [UI](https://github.com/bitgapp/eqMac/tree/master/ui) - Web based user interface that is hosted remotely and thus allows for over the air updates & bug fixes. Written in Angular 8 and uses Service Workers to guarantee offline access.
+* [UI](https://github.com/bitgapp/eqMac/tree/master/ui) - Web based user interface that is hosted remotely and thus allows for over the air updates & bug fixes. Written in Angular 8 and uses is cached for offline availability.
 * [Site](https://github.com/bitgapp/eqMac/tree/master/site) - Source code for https://eqmac.app website. Written in Angular 8 and server side rendered using [Angular Universal](https://github.com/angular/universal)
 
 ## Contribution
-At the moment eqMac is going through a major rewrite and it's hard to coordinate the development of big features, but I'm open to try anyway. Please create an issue on GitHub (please check if your issue is already being discussed) or [join our Discord](https://discord.gg/BA22ceW) to discuss.
+At the moment eqMac is going through a major rewrite and it's hard to coordinate the development of big features, but I'm open to try anyway. Please create an issue on GitHub (please check if your issue is already being discussed) or [join our Discord](https://discord.eqmac.app) to discuss. Once a piece of work has been agreed - fork, build, debug, fix, merge and create a Pull Request to get your work merged in :) 
+Check the documentation below to understand how to start eqMac debug process from Xcode
 
+## Development
+Fork the repository, then run these commands in Terminal.app:
+
+``` 
+git clone https://github.com/YOUR_USERNAME/eqMac.git
+cd eqMac/
+```
+
+### Web User Interface
+If you want to run the web based User Interface locally then you need to follow these steps to make that happen:
+
+#### Prerequisites
+Install [Node.js](https://nodejs.org/en/) LTS version preferrably using [NVM](https://github.com/nvm-sh/nvm#installing-and-updating)
+
+#### Building and running the Web UI
+1. Go into the ui/ directory by `cd ui/`
+2. Install Node dependencies with `npm install`
+3. Start local development server with `npm start`
+
+### Native app + driver
+#### Prerequisites
+
+1. Download [Xcode](https://apps.apple.com/us/app/xcode/id497799835?mt=12)
+2. Install [CocoaPods](https://cocoapods.org/) by `sudo gem install cocoapods`
+3. Install [Carthage](https://github.com/Carthage/Carthage#installing-carthage) by `brew update && brew install carthage`
+
+#### Building and running the App
+
+1. Go into the native/app directory from root of the repo by: `cd native/app/`
+2. Install Cocoapod dependencies: `pod install`
+3. Install Carthage dependencies: `carthage update`
+4. Go back to the native/ directory: `cd ../`
+5. Open the Xcode workspace: `open eqMac.xcworkspace`
+6. Launch eqMac in debug mode by running the **App - Debug** Scheme:
+<img width="512" src="https://user-images.githubusercontent.com/8472525/83069640-279c1100-a062-11ea-85a7-45aa5253771b.png"/>