From 7278438bfabc8b1897549902f0164e27aac90bab Mon Sep 17 00:00:00 2001 From: Anonymus Raccoon <32224410+AnonymusRaccoon@users.noreply.github.com> Date: Fri, 3 May 2019 13:32:20 +0200 Subject: [PATCH 1/5] Update README.md --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fdef271..5770af3 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,16 @@ # Opus -**You can find a good description of the app here: https://anonymusraccoon.github.io/RaccoonWebsite/en/** - -MusicApp has just renamed into Opus +This is an android app for playing music from local file or from youtube (while screen is off). You can as well edit metadata tag and manage playlist (local one or youtube one). If you want to download the app, check on the Release tabs. -This is an android app for playing music from local file or from youtube (while screen is off). You can as well edit metadata tag and manage playlist (local one or youtube one). +**This ReadMe is for developers only, if you want to see what the app can do, please take a look at this website: https://www.raccoon-sdg.fr/en** -## Screenshots -![Player](https://raw.githubusercontent.com/AnonymusRaccoon/MusicApp/master/Screenshots/Player.jpg) -![Queue](https://raw.githubusercontent.com/AnonymusRaccoon/MusicApp/master/Screenshots/Queue.jpg) -![EditMetaData](https://raw.githubusercontent.com/AnonymusRaccoon/MusicApp/master/Screenshots/EditMetaData.jpg) -![YoutubeSearch](https://raw.githubusercontent.com/AnonymusRaccoon/MusicApp/master/Screenshots/YoutubeSearch.jpg) -![Playlists](https://raw.githubusercontent.com/AnonymusRaccoon/MusicApp/master/Screenshots/Playlists.jpg) -![Browse](https://raw.githubusercontent.com/AnonymusRaccoon/MusicApp/master/Screenshots/Browse.jpg) -![Settings](https://raw.githubusercontent.com/AnonymusRaccoon/MusicApp/master/Screenshots/Settings.jpg) +Like every android app, every layouts are ine the Resources/layout folder. + +The code of the app is devided in 4 differents folders: + + - The DataStructure project which contains classes/objects that are used to represents basic objects of the app (like songs or playlists). This folder also contains ViewHolders (classes that are used to bind layouts with data) + - + - The API folder which contains all the methods that If you find an issues or want to contribute to the project, open a request here. From 07f3c3526cd557bf3aca6f3cf68ce59231a4e81b Mon Sep 17 00:00:00 2001 From: Anonymus Raccoon <32224410+AnonymusRaccoon@users.noreply.github.com> Date: Fri, 3 May 2019 13:56:21 +0200 Subject: [PATCH 2/5] Update README.md --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5770af3..43d7a4e 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,18 @@ Like every android app, every layouts are ine the Resources/layout folder. The code of the app is devided in 4 differents folders: - The DataStructure project which contains classes/objects that are used to represents basic objects of the app (like songs or playlists). This folder also contains ViewHolders (classes that are used to bind layouts with data) - - - - The API folder which contains all the methods that + - The UI folder which contains itself 3 folders: + - The Fragment folder, containing every tab of the app (the youtube search, the playlist tab...) + - The Adaptet folder, containing every adapter of the app. An adapter is something that bind a list (of songs, of playlists...) to a listview so the user can scroll, click... + - The View folder, containing other views that are a bit more compext than other tabs (like the player or the queue). It also contains custom views that need custom calculations for a random reason. + - The API folder which contains statics methodes that are used everywhere in the app. Inside this folder, you have: + - The LocalManager contains methods used to manage local songs. Inside this you have methodes like the shuffle all, a method to play a local song... + - The YoutubeManager contains methods to manage youtube songs. It's the same as the LocalManager but for youtube songs. + - The SongManager contains generics methods for a song (like play methods). It will check how to interpret the song and use the correct method (local or youtube one). + - The PlaylistManager contains methods for playlists (both locals and youtubes one). + - This folder also contains a subfolder named Services. This folder contains things that run in background without a UI implementation. These classes behave without the help of other classes. You have: + - The MusicPlayer service, which is the most complicated but the most used. It's the one which manage the playback. + - The Downloader, allowing you to download songs or playlists. This service is the one with the more UI callbacks. + - The Sleeper which is the one managing the sleep timer. If you find an issues or want to contribute to the project, open a request here. From d208c0c781f5e5340255f8c4dac88c93f44e5477 Mon Sep 17 00:00:00 2001 From: Anonymus Raccoon <32224410+AnonymusRaccoon@users.noreply.github.com> Date: Fri, 3 May 2019 13:56:59 +0200 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 43d7a4e..e8d3e1a 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Like every android app, every layouts are ine the Resources/layout folder. The code of the app is devided in 4 differents folders: - - The DataStructure project which contains classes/objects that are used to represents basic objects of the app (like songs or playlists). This folder also contains ViewHolders (classes that are used to bind layouts with data) + - The DataStructure folder which contains classes/objects that are used to represents basic objects of the app (like songs or playlists). This folder also contains ViewHolders (classes that are used to bind layouts with data) - The UI folder which contains itself 3 folders: - The Fragment folder, containing every tab of the app (the youtube search, the playlist tab...) - The Adaptet folder, containing every adapter of the app. An adapter is something that bind a list (of songs, of playlists...) to a listview so the user can scroll, click... From acbb147d462b078742b7e3eb9971ea394d14dc5f Mon Sep 17 00:00:00 2001 From: Anonymus Raccoon <32224410+AnonymusRaccoon@users.noreply.github.com> Date: Fri, 3 May 2019 14:01:00 +0200 Subject: [PATCH 4/5] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index e8d3e1a..56eb468 100644 --- a/README.md +++ b/README.md @@ -23,5 +23,6 @@ The code of the app is devided in 4 differents folders: - The MusicPlayer service, which is the most complicated but the most used. It's the one which manage the playback. - The Downloader, allowing you to download songs or playlists. This service is the one with the more UI callbacks. - The Sleeper which is the one managing the sleep timer. + - The Other folder which contains classes that are not really usful in itself but are needed. Like images transformaters (things that remove black borders in image, make them in circles...) If you find an issues or want to contribute to the project, open a request here. From dd8469242e6a8da5ba6291deb62b76ec068362b9 Mon Sep 17 00:00:00 2001 From: Anonymus Raccoon <32224410+AnonymusRaccoon@users.noreply.github.com> Date: Fri, 3 May 2019 14:03:17 +0200 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 56eb468..f877373 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,6 @@ The code of the app is devided in 4 differents folders: - The MusicPlayer service, which is the most complicated but the most used. It's the one which manage the playback. - The Downloader, allowing you to download songs or playlists. This service is the one with the more UI callbacks. - The Sleeper which is the one managing the sleep timer. - - The Other folder which contains classes that are not really usful in itself but are needed. Like images transformaters (things that remove black borders in image, make them in circles...) + - The Other folder which contains classes that are not really usful in itself but are needed. Like images transformaters (things that remove black borders in image, make them in circles...). It also contains some callbacks (Chromecast one, some for the snackbars...). If you find an issues or want to contribute to the project, open a request here.