From 6e7c3db0c23fe5b30e1f310b3a894eeffbbf4c1f Mon Sep 17 00:00:00 2001 From: Kartik Venugopal Date: Mon, 11 Nov 2024 00:27:50 +0100 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0b82d17c7..ccd548dc7 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,8 @@ Aural is an audio file player for macOS. Inspired by the classic Winamp player for Windows, it is designed to be easy-to-use and customizable ... a simple drag-drop-play player that can do a lot! +______ + ## Key features ### Flexible UI @@ -40,17 +42,19 @@ With several built-in effects and support for Audio Unit (AU) plug-ins, sound tu ### Usability Command Aural from multiple places and in many ways - Configurable media keys, swipe/scroll gestures, Control Center, headphones, and media control devices / apps ("remote control"). -Read the comprehensive feature list [here](https://github.com/kartik-venugopal/aural-player/wiki/Features) +Read the comprehensive feature list [here](https://github.com/kartik-venugopal/aural-player/wiki/Features). + +______ -### Roadmap +## Roadmap -#### Version 3 archived +### Version 3 archived Version 3 has been archived, and no further work will be done on it. The source code for it can be found in the new repository: [aural-player-archive](https://github.com/kartik-venugopal/aural-player-archive) All pending and newly filed issues (bugs or feature requests), if implemented, will be implemented in v4. -#### Version 4 being developed (coming soon!) +### Version 4 being developed (coming soon!) 12 "preview" releases have already been put out. These pre-release builds are considered experimental, with the disclaimer that they may contain significant bugs. @@ -62,6 +66,8 @@ As of Nov 11, 2024, there are 2 upcoming major milestones for Version 4: There are no current date estimates for the milestone releases. +______ + ## How it works (under the hood) Aural Player uses **AVFoundation's AVAudioEngine** framework (and some low-level **Core Audio**) for playback, effects, and visualization, and uses **FFmpeg** libraries to decode formats not native to macOS. @@ -79,6 +85,8 @@ Read more about it [here](https://github.com/kartik-venugopal/aural-player/wiki/ * Currently, Aural does not play online streams. * Aural does not play protected content (for example, Apple's M4P or Audible's AAX). There are no plans to implement this. +______ + ## Download [Latest release](https://github.com/kartik-venugopal/aural-player/releases/latest) @@ -105,6 +113,8 @@ This table lists the range of compatible Aural Player versions for your hardware Your Mac media keys should work with Aural right out of the box (assuming you granted Aural Accessibility permissions on first app launch), but if for some reason the media keys don't work, follow the steps listed [here](https://github.com/kartik-venugopal/aural-player/wiki/Enabling-media-keys-support). +______ + ## Building the app All you need is Xcode 12.2+ and the [source code](https://github.com/kartik-venugopal/aural-player/releases/latest) (a working knowledge of Swift would help !). It is recommended to use the source code from the latest release (as opposed to the master branch) as code between releases can be buggy / unstable. @@ -124,6 +134,8 @@ All the documentation can be found on the [wiki](https://github.com/kartik-venug [Building and running Aural Player (quick start guide)](https://github.com/kartik-venugopal/aural-player/wiki/Building-and-running-Aural-Player-(quick-start-guide)) [Developer reference](https://github.com/kartik-venugopal/aural-player/wiki/Developer-reference) + +______ ## Known issues (and solutions) @@ -133,6 +145,8 @@ All the documentation can be found on the [wiki](https://github.com/kartik-venug * [My media keys don't work with Aural Player](https://github.com/kartik-venugopal/aural-player/wiki/My-media-keys-don't-work-with-Aural-Player) +______ + ## Contact and conversation **(NEW!) Discussions:** https://github.com/kartik-venugopal/aural-player/discussions @@ -143,6 +157,8 @@ All the documentation can be found on the [wiki](https://github.com/kartik-venug The app is what it is today largely thanks to the numerous bug reports and valuable feedback of users over the years. I urge you to file issues for any bugs you encounter or for features / behavior you would like to see implemented. I am generally pretty good at responding to issues, and at the very least, I will read, contemplate, and respond. +______ + ## Third party code attributions * [FFmpeg](https://www.ffmpeg.org/) (used to decode audio formats not natively supported on macOS) @@ -162,6 +178,8 @@ Fellow GitHub member [dun198](https://github.com/dun198) made significant contri I am also hugely grateful to all the app users who have filed bug reports and feature requests, and provided valuable feedback. +______ + ## License Aural Player (in both forms - source code and binary) is available for use under the [MIT license](https://github.com/kartik-venugopal/aural-player/blob/master/LICENSE).