Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to README.md #553

Merged
merged 10 commits into from
Mar 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 42 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,13 @@
- [Download](#download)
- [Features](#features)
- [Translations](#translations)
- [Contributing](#contributing)
- [License](#license)


# Description

Home of **Music Player GO**, a minimal yet fully-featured local Android music player aiming at **simplicity** and performance
Welcome to **Music Player GO**, your go-to local Android music player that strikes the perfect balance between simplicity and performance. Dive into a world where your music is organized intuitively, offering a minimal yet fully-featured experience!


# Download
Expand All @@ -76,18 +77,55 @@ Home of **Music Player GO**, a minimal yet fully-featured local Android music pl
- Queue
- Sleep timer
- Audio focus, precise volume and headset management
- Now playing, embedded covers, search, playback speed, pause on completion, sorting, shuffle, fast-seeking...
- Now playing, embedded covers, search, playback speed, pause on completion, sorting, shuffle, fast-seeking, and more!


# Translations

Help us to translate the project on [Hosted Weblate](https://hosted.weblate.org/engage/music-player-go/).
Consider sending some [love](https://weblate.org/donate/new/) to the Weblate guys who made easy translations possible. :)
We currently need help translating the project so our app can be more accessible to everyone worldwide!
The image below is an overview of the language translations that are currently being worked on:
- The smaller red bars indicate that there is a significant amount of translating needed
- We would ideally like each language to reach to green (less translations needed)
- Please feel free to add new languages that are not currently being translated

In order to contribute please use [Weblate](https://hosted.weblate.org/engage/music-player-go/).
You will need to create an account with Weblate (if you don't already have one) in order to do so.

It would also be greatly appreciated if you could send some [love](https://weblate.org/donate/new/) to the Weblate contributors who made easy translations possible :)
By clicking the link, you will be directed to the Weblate monetary donations page, where you will also be prompted to sign in or create an account.

<a href="https://hosted.weblate.org/engage/music-player-go/">
<img src="https://hosted.weblate.org/widgets/music-player-go/-/horizontal-auto.svg" alt="Stato traduzione" />
</a>

# Contributing

Thank you for considering contributing to Music Player GO! We welcome contributions from the community to help improve and grow this project. Below are some guidelines for front and back end contributions. If you would like to contribute towards translations, please see the above [Translations](#translations) section.

### How to Contribute

* Feel free to submit pull requests for any contributions, using a [feature branch](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow).
* Once you have submitted a pull request, we will need to review and appove it before it can be merged with the project.
* After your contribution has been added we can add you to our list of [contributors](CONTRIBUTORS.md)!
* We would greatly appreciate if you could look at the [issues](https://github.com/enricocid/Music-Player-GO/issues) tab to see what needs fixing, especially if there are any bugs!!
* While there is no strict coding style for this project, we encourage you to strive for consistency within the existing codebase and UI following with the minimalistic aesthetic of the application.
* Please make sure to look at the the [FAQ's](FAQ.md), [Privacy Policy](PRIVACY_POLICY.md), [Formats](FORMATS.md), [libraries we utilize](LIBS.md), and [our license](LICENSE.md) before you get started to familiairze yourself with our app and frameworks.


To get started, you would need to clone/fork this repository:
- Note *user* refers to your GitHub username

### Windows Terminal commands:

git clone https://github.com/*user*/Music-Player-GO.git

cd Music-Player-GO

### Mac Terminal commands:

git clone https://github.com/*user*/Music-Player-GO.git

cd Music-Player-GO

# License

Expand Down
Loading