diff --git a/README.md b/README.md index 36821cc..353e910 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Apple Music Clone +๏ปฟ# Apple Music Clone ## Project Overview @@ -8,47 +8,73 @@ sophisticated UI to control their playback. This clone does not. Apple Music Clone is an application built on the .NET MAUI (Multi-platform App UI) -framework. It focuses on the `Library` "master-detail". As of the 20th of May 2023, -it is a _fa็ade_: only the View part of the project is serviceable. +framework. It attempts to follow an MVVM architecture pattern. It focuses on the +`Library` "master-detail". -## The View +* ### :lipstick: The View + As of the 20th of May 2023, it is a faรงade: only the + View part of the project is serviceable. + + + +
+ + +
+ + +
+ + + +
more details... -* ### Library ("master") + * #### Library ("master") ๐Ÿ’ - Users can browse a `Library` of `Album` and select any album to inspect. + Users can browse a `Library` of `Album` and select any album to inspect. -* ### Album ("detail") + * #### Album ("detail") ๐ŸŒป - Users can browse an `Album` of `Songs`. + Users can browse an `Album` of `Songs`. -* ### Dark/Light theme + * #### Dark/Light themes ๐ŸŒ™ โ˜€๏ธ - This clone replicates the original dark/light themes by Apple music. + This clone replicates the original dark/light themes by Apple music. - To test this, you can change your device's (or your emulator's) display + To test this, you can change your device's (or your emulator's) display setting to dark/light theme. -* ### `i18n`: `en`, `fr` + * #### `i18n` ๐Ÿ‡บ๐Ÿ‡ธ ๐Ÿ‡ซ๐Ÿ‡ท - This clone supports two locales: English (by default), and French. + This clone supports two locales: English (by default), and French. - To test this, you can change your device's (or your emulator's) primary language + To test this, you can change your device's (or your emulator's) primary language settings to English/French. -* ### Bottom bar + * #### Top bar โ˜๏ธ - In Apple Music, a consistent, stylish, slightly transparent bottom bar allows + In Apple Music, a stylish, slightly transparent top bar contains certain menu +options, and displays the name of the current +section once the user has scrolled past the corresponding header. + + In this clone, the top bar is left at the OS default. + + * #### Bottom bar ๐Ÿ‘‡ + + In Apple Music, a consistent, stylish, slightly transparent bottom bar allows navigation between different views, and paying songs. - In this clone, the bar is just eye-candy, and not even a little bit transparent. + In this clone, the bar is just eye-candy, and not even a little bit transparent. -* ### Top bar + - In Apple Music, a stylish, slightly transparent top bar contains certain menu -options, and displays the name of the current -section once the user has scrolled past the corresponding header. +* ### ๐Ÿ–– The ViewModel + + A very basic ViewModel is in place, and for now it simply provides some sample data. + +* ### :necktie: The Model - In this clone, the top bar is left at the OS default. + A very basic Model is in place, to help the ViewModel supply some sample data. ## Installation diff --git a/docs/dark_fr_alb_down.png b/docs/dark_fr_alb_down.png new file mode 100644 index 0000000..36ab84a Binary files /dev/null and b/docs/dark_fr_alb_down.png differ diff --git a/docs/dark_fr_alb_up.png b/docs/dark_fr_alb_up.png new file mode 100644 index 0000000..1d2fd44 Binary files /dev/null and b/docs/dark_fr_alb_up.png differ diff --git a/docs/dark_fr_lib_down.png b/docs/dark_fr_lib_down.png new file mode 100644 index 0000000..7a10149 Binary files /dev/null and b/docs/dark_fr_lib_down.png differ diff --git a/docs/dark_fr_lib_up.png b/docs/dark_fr_lib_up.png new file mode 100644 index 0000000..0e5439a Binary files /dev/null and b/docs/dark_fr_lib_up.png differ diff --git a/docs/light_en_alb_down.png b/docs/light_en_alb_down.png new file mode 100644 index 0000000..2cafa72 Binary files /dev/null and b/docs/light_en_alb_down.png differ diff --git a/docs/light_en_alb_up.png b/docs/light_en_alb_up.png new file mode 100644 index 0000000..c9e378a Binary files /dev/null and b/docs/light_en_alb_up.png differ diff --git a/docs/light_en_lib_down.png b/docs/light_en_lib_down.png new file mode 100644 index 0000000..1641562 Binary files /dev/null and b/docs/light_en_lib_down.png differ diff --git a/docs/light_en_lib_up.png b/docs/light_en_lib_up.png new file mode 100644 index 0000000..60c370b Binary files /dev/null and b/docs/light_en_lib_up.png differ