Skip to content

Commit 3b4c433

Browse files
authored
Update README.md
1 parent d9b77c9 commit 3b4c433

1 file changed

Lines changed: 22 additions & 20 deletions

File tree

README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Idea is to become the ultimate Audio toolbox for macOS (some features might not
3636
* and more...
3737

3838
## User support
39-
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.
39+
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), I'm there all the time and I like to chat with people.
4040

4141
## Technology
4242
eqMac was built using these technologies:
@@ -45,17 +45,9 @@ eqMac was built using these technologies:
4545
* [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. Built with [Angular](https://angular.io/) + [TypeScript](https://www.typescriptlang.org/) and is cached for offline availability.
4646

4747
## Contribution
48-
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 :)
48+
At the moment eqMac is going through a major rewrite and it's hard to coordinate the development of big features. But bug fixes, performance optimizations and refactoring PR's are welcomed! 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 :)
4949
Check the documentation below to understand how to start eqMac debug process from Xcode
5050

51-
## Credits
52-
53-
[@nodeful](https://github.com/nodeful) - Creator and Developer of eqMac
54-
55-
Apple Inc. - For open sourcing this [HAL Driver Example](https://developer.apple.com/documentation/coreaudio/creating_an_audio_server_driver_plug-in)
56-
57-
[@titanicbobo](https://github.com/titanicbobo) - For the [Big Sur icon design](https://github.com/bitgapp/eqMac/blob/master/assets/icon/icon.svg)
58-
5951
## Development
6052
Fork the repository, then run these commands in Terminal.app:
6153

@@ -64,7 +56,22 @@ git clone https://github.com/YOUR_USERNAME/eqMac.git
6456
cd eqMac/
6557
```
6658

59+
### Native app + driver
60+
#### Prerequisites
61+
62+
1. Download [Xcode](https://apps.apple.com/us/app/xcode/id497799835?mt=12)
63+
2. Install [CocoaPods](https://cocoapods.org/) by `sudo gem install cocoapods`
64+
65+
#### Building and running the App
66+
67+
1. Go into the native/app directory from root of the repo by: `cd native/`
68+
2. Install Cocoapod dependencies: `pod install`
69+
3. Open the Xcode workspace: `open eqMac.xcworkspace`
70+
4. Launch eqMac in debug mode by running the **App - Debug** Scheme:
71+
<img width="512" src="https://user-images.githubusercontent.com/8472525/83069640-279c1100-a062-11ea-85a7-45aa5253771b.png"/>
72+
6773
### Web User Interface
74+
You don't need to run the UI code locally to debug just the Swift side of the app, unless you want to debug the UI code :)
6875
If you want to run the web based User Interface locally then you need to follow these steps to make that happen:
6976

7077
#### Prerequisites
@@ -77,16 +84,11 @@ Install [Yarn](https://classic.yarnpkg.com/en/) v1 globally: `npm i -g yarn` (th
7784
2. Go into the ui/ directory by `cd ui/`
7885
3. Start local development server with `yarn start`
7986

80-
### Native app + driver
81-
#### Prerequisites
8287

83-
1. Download [Xcode](https://apps.apple.com/us/app/xcode/id497799835?mt=12)
84-
2. Install [CocoaPods](https://cocoapods.org/) by `sudo gem install cocoapods`
88+
## Credits
8589

86-
#### Building and running the App
90+
[@nodeful](https://github.com/nodeful) - Creator and Developer of eqMac
8791

88-
1. Go into the native/app directory from root of the repo by: `cd native/`
89-
2. Install Cocoapod dependencies: `pod install`
90-
3. Open the Xcode workspace: `open eqMac.xcworkspace`
91-
4. Launch eqMac in debug mode by running the **App - Debug** Scheme:
92-
<img width="512" src="https://user-images.githubusercontent.com/8472525/83069640-279c1100-a062-11ea-85a7-45aa5253771b.png"/>
92+
Apple Inc. - For open sourcing this [HAL Driver Example](https://developer.apple.com/documentation/coreaudio/creating_an_audio_server_driver_plug-in)
93+
94+
[@titanicbobo](https://github.com/titanicbobo) - For the [Big Sur icon design](https://github.com/bitgapp/eqMac/blob/master/assets/icon/icon.svg)

0 commit comments

Comments
 (0)