Add dark themes

README.md

@@ -1,2 +1,28 @@
-# FlatLogicWorld
-Material Design themes for the game Logic World
+# Flat Logic World
+Give Logic World a fresh new look with Material Design colors! 
+
+> A flat UI perfectly matching the flat earth in Logic World :stuck_out_tongue_closed_eyes:
+
+<!-- TODO: Main menu picture -->
+
+## Installation
+Mod support in Logic World is not finished yet but the mod directory can already be used for external color pallets.
+
+1. Download ZIP from the latest [release](https://github.com/mastercaution/FlatLogicWorld/releases)
+2. Extract and copy the `FlatLogicWorld` folder to the mods folder: `Logic World/GameData` (the game can open it for you `Main Menu > Mods > Open Mods Folder`)
+3. If the game is running, restart it and done :tada:
+
+## Usage
+1. Navigate to `Settings > User Interface`
+2. At option "Theme" choose a "Material Dark [color]" theme from the dropdown menu
+3. Profit
+
+## Known Issues
+- __Scrollbars are invisible in component selection menu.__ The scroll bar in the component selection menu is assigned to the color `Primary` and the scrollbar background to `Tertiary`. Both colors are equal in the _Flat Logic World_ themes giving them the flat and clean look. Hovering over the scrollbar will reveal it. This only effects the scrollbars in the component selection menu, other scrollbars use other colors that work well.
+- __Text in dropdowns are gray and not black.__ The text color of the selected item in a collapsed dropdown element is hard-coded to that gray, so it cannot be customized by the color palette. That's why the dropdowns are that bright, making them darker would make the text very hard to read.
+
+## Pictures
+<!-- TODO: Pictures -->
+
+## Acknowledgements
+Huge thanks to Mouse Hat Games (especially Jimmy) for the great game and the modularity making it super easy to create custom themes and other mods!