Merge branch 'master' of https://github.com/Madelena/Metrology-for-Mu…

…sicbee

README.md

@@ -1,2 +1,48 @@
-# Metrology-for-Musicbee
-
+# Metrology for MusicBee
+
+Metrology is a practical series of app customizations and redesigns aimed at bringing a bold, clear, and consistent user experience to various Windows and Android apps. Its design language is based on [Metro](https://en.wikipedia.org/wiki/Metro_(design_language)) and [Fluent](https://www.microsoft.com/design/fluent/) design systems pioneered by Microsoft Design since the 2010s.
+
+[MusicBee](https://getmusicbee.com) is a highly customizable audiophile-grade music player for Windows. This is a skin for the Theater Mode, which displays the currently playing track in a large or full screen format.
+
+There are 5 skins in development:
+
+![Zune](https://i.imgur.com/FXmzjab.png)
+**Zune**: A detailed and accurate replica of the Zune/WP7 Music user interface.
+
+![Fluent Carousel](https://i.imgur.com/woTA1aK.png)
+**Fluent Carousel**: Display the next 10 tracks in a perspective view.
+
+![Fluent](https://i.imgur.com/cVU1DYu.jpg)
+**Fluent**: A bold and clean UI that fits well with Windows 10.
+
+Optionally, a 4K fullscreen version and a clean version with no controls are available.
+
+## How to Install
+
+Download the latest release here: https://github.com/Madelena/Metrology-for-Musicbee/releases
+
+### Method A: Install using MusicBee
+![Method A Screenshot](https://i.imgur.com/DQd2vOL.png)
+Remember to add the XML file as a Theater Mode Skin, not a normal Skin! Look for the right menu item marked under View > Theater Mode. If you make the mistake of installing as a normal Skin, your MusicBee will *crash hard*.
+
+### Method B: Install by copying files in Explorer
+![Method B Screenshot](https://i.imgur.com/nJtZ6S1.png)
+Find the folder where you installed MusicBee, which is usually under C:\Program Files (x86)\MusicBee\. Go to the Plugins folder and you will find two TheaterMode folders.
+
+If you want to use the Theater Mode in a tab in the main window as a Now Playing view, or if you want to use it in Compact View, copy the xml file to TheaterMode.Embeded.
+
+If you want to use the Theater Mode as a full screen window or its own window, copy the xml file to TheaterMode.List.
+
+## System Requirements
+* MusicBee 3.x
+* Windows 10 with the Segoe MDL2 Assets font. Without it all the icons won't work. If you aren't on Windows 10 1903 or later, download the font here: https://aka.ms/SegoeFonts
+
+## Credits
+
+![Creative Commons License](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)
+
+This work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/).
+
+Additionally, I would appreciate proper credits back to me if redistributed or modified. That would help my livelihood since design is [my career](https://MadelenaMak.com).
+
+The initial code was partially based on the Rdio Theater Mode view.