Auxio/README.md
OxygenCobalt ed33813112
Add proper README
Add a proper readme and other documents for this project.
2020-12-18 17:15:57 -07:00

75 lines
No EOL
3.2 KiB
Markdown

<p align="center"><img src="info/ic_auxio.png" width="150"></p>
<h1 align="center"><b>Auxio</b></h1>
<h4 align="center">A sensible and customizable music player for android.</h4>
<p align="center">
<a href="https://github.com/oxygencobalt/Auxio/releases">
<img alt="GitHub release" src="https://img.shields.io/static/v1?label=Tag&message=v1.0.0&color=0D5AF5">
</a>
<a href="https://www.gnu.org/licenses/gpl-3.0">
<img src="https://img.shields.io/badge/License-GPL%20v3-blue.svg">
</a>
<img alt="Minimum SDK" src="https://img.shields.io/badge/API-21%2B-32B5ED">
</p>
<h4 align="center"><a href="/info/FAQ.md">FAQ</a> / <a href="/info/FORMATS.md">Formats</a> / <a href="/info/LICENSES.md">Licenses</a> / <a href="/.github/CONTRIBUTING.md">Contributing</a></h4>
## About
Auxio is a music player for android that I built for myself, its intended to only have the features that I use out of a music player and nothing more.
However, Auxio is also structured to be customizable and extendable, in the case you want to add features that I personally don't need.
## Screenshots
[<img src="info/shot_library_port.png" width=160>](info/shot_library_port.png)
[<img src="info/shot_playback_port.png" width=160>](info/shot_playback_port.png)
[<img src="info/shot_songs_port.png" width=160>](info/shot_songs_port.png)
[<img src="info/shot_search_port.png" width=160>](info/shot_search_port.png)
[<img src="info/shot_album_port.png" width=160>](info/shot_album_port.png)
[<img src="info/shot_artist_port.png" width=160>](info/shot_artist_port.png)
[<img src="info/shot_queue_port.png" width=160>](info/shot_queue_port.png)
[<img src="info/shot_notif.png" width=160>](info/shot_notif.png)
[<img src="info/shot_settings_port.png" width=160>](info/shot_settings_port.png)
[<img src="info/shot_album_alt.png" width=160>](info/shot_album_alt.png)
## Features
- Reliable, ExoPlayer based playback
- Customizable UI & Behavior
- Extensive Genres/Artists/Albums/Songs support
- Powerful queue system
- Full playback persistence system
- Embedded covers support
- Search Functionality
- No internet connectivity whatsoever
- Kotlin from the ground-up
- Modular, feature-based architecture
- No rounded corners (The way god intended)
## To Come in the future:
- Better music loading system
- Improved genre/artist/album UIs
- Dedicated search tab
- Better edge-to-edge support
- Black theme
- Custom accents
- Playlists
- Liked songs
- More customization options
- Other things, presumably
## Contributing
Auxio accepts most contributions as long as they follow the [Contribution Guidelines](/.github/CONTRIBUTING.md).
Feature additions and Major UI changes are less likely to be accepted. See [Accepted Additions](/info/ADDITIONS.md) for more information.
## License
[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)
Auxio is Free Software: You can use, study share and improve it at your
will. Specifically you can redistribute and/or modify it under the terms of the
[GNU General Public License](https://www.gnu.org/licenses/gpl.html) as
published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.