Skip to content
This repository
Newer
Older
100644 92 lines (55 sloc) 5.366 kb
5a3425c9 »
2012-09-16 Added README
1 ## Sonora
2 ### A minimal, beautifully designed music player for the Mac
3 #### Developed by [Indragie Karunaratne](http://indragie.com)
4 #### Designed by [Tyler Murphy](http://twitter.com/tylrmurphy)
5
6 ![Sonora](http://indragie.com/images/sonora.png)
7
8 Sonora (previously sold on the App Store, **now open source**) is a relatively new music player for the mac with a clean, minimal design and some awesome features that greatly enhance your every day music listening experience. Some of the highlights of Sonora include:
9
10 - **Visually immersive**. No more long, boring lists of text. View your albums in a grid with gorgeous artwork.
11 - **Fast**. Almost all of Sonora's UI is built on top of Core Animation, which makes for a super smooth and silky experience.
12 - **Support for tons of formats**. Literally. Sonora supports every format under the sun, thanks to [SFBAudioEngine](https://github.com/sonoramac/SFBAudioEngine)
13 - **Instant search**. Type anywhere inside the app to instantly search through your albums, artists, songs, and mixes. It even has a global search window with a customizable hot key to play and enqueue music without interrupting your workflow.
14 - **Queue**. Sonora utilizes a central queue for all music playback. Easily add, remove, and rearrange songs to customize your listening queue on the fly. Save your queue as a mix with the click of a button.
15 - **Social**. Built in Last.fm scrobbling and sharing to Twitter, iMessage, and Email (via OS X Mountain Lion).
16
17 ### Why was this open sourced?
18
a8cfd1a9 »
2012-09-17 Update post link
19 A lot of reasons. Read [this blog post](http://blog.indragie.com/post/1-2-open-source) for more information on our decision.
5a3425c9 »
2012-09-16 Added README
20
21 ### How to compile
22
23 **Prerequisites**
24
25 - [mogenerator](https://github.com/rentzsch/mogenerator)
26 - [CocoaPods](https://github.com/CocoaPods/CocoaPods)
27
28 For the next steps, you have two options. There is a fast way to compile Sonora and the best way. The fast way uses a ZIP of external libraries that I've already set up and configured, but these libraries may not be up to date because I don't have the time to update the ZIP every time something little changes. The best way is to set up the dependencies yourself and ensure that you always have the latest versions of the libraries.
29
30
31 #### Fastest way
32
2dd3c258 »
2012-09-27 Fixed the Libraries.zip url
33 - Download the [Libraries.zip](https://github.com/downloads/sonoramac/Sonora/Libraries.zip) file from the Downloads section
5a3425c9 »
2012-09-16 Added README
34 - Unzip it into the Sonora folder, replacing existing directories if necessary
35
36 #### Best way
37
38 - Add the Sonora podspecs repository to CocoaPods:
39
40 ```
41 pod repo add Sonora-Podspecs git://github.com/sonoramac/Podspecs.git master
42 ```
43 - Download and set up all the pods:
44
45 ```
46 cd <project directory>
47 pod install
48 ```
49 - Download the submodules:
50
51 ```
52 git submodule update --init --recursive
53 ```
54
55 - **SFBAudioEngine** requires frameworks that aren't included in the main repository. Download the Frameworks archive [here](https://github.com/downloads/sbooth/SFBAudioEngine/Frameworks.tar.bz2) and place the Frameworks folder inside Sonora/External/SFBAudioEngine/.
56
57
58 #### After you've followed either method:
59
60 - Read instructions in `SNRConstants.m` to fill in extra information that may be necessary
61 - Compile **(make sure to open Sonora.xcworkspace and not the xcodeproj)!**
62
63
64 ### State of the Code
65
66 The app is very much functional, but there's certainly a lot of bugs to fix. Large parts of Sonora have been rewritten for Sonora 2, but a lot of old code remains. Some of this was written while I was still in the process of fully learning Cocoa and Objective-C, so I may be doing some unspeakably horrible things :)
67
68 I could definitely use everyone's help in fixing and improving things.
69
70 ### Contributing
71
72 One of the reasons we open sourced Sonora is because a music player is difficult for one man to maintain, and the community's help is essential in order to keep Sonora in good shape.
73
74 If you want to contribute, please take a look at the issues for this repository and see if there are any bugs in there that you want to fix or features you want to implement. If you need a design to implement a particular feature, please create a new issue with the **design** tag and we'll do our best to supply PSDs.
75
012213a9 »
2012-09-16 Update README.md
76 Once you have made additions, please send us a pull request and we will review and merge your contributions. If you're actively making large contributions to Sonora, we would love to add you to the team and give you push access to the repository so that you won't need to bother with pull requests.
5a3425c9 »
2012-09-16 Added README
77
78 ### Bugs
79
80 If you find a bug, please file an issue with as much information as possible. **DO NOT file issues for feature requests. We get too many of these and we will decide what new features are needed.**
81
82 ### PSDs
83
84 The PSDs for Sonora's design are being cleaned up right now and will be posted in this repository when they are ready.
85
86 ### License
87
88 Sonora is licensed under the BSD license. See LICENSE file for more info.
89
90 Please, **please** don't just compile Sonora (or take the code and rename the app) and sell it somewhere. ie. Don't be a terrible person. We decided to use a nonrestrictive license because we hate those other licenses as much as everyone else does.
91
92 We've spent many years and thousands of hours working on Sonora, and the last thing we want to see is someone ripping it and selling it for their own profit with minimal effort on their part. **Just don't do it.**
Something went wrong with that request. Please try again.