Merge pull request #98 from Dragon8oy/master

Compress .svg, modify 4MLinux and android icons, fix grub transparency issue

.gitignore

@@ -0,0 +1,2 @@
+git-v1.sh
+setup-git-v1.sh

README.md

@@ -7,48 +7,78 @@
 
 ```
 
-## Flat Design themes for Grub2.
+## Flat Design themes for Grub
 
-## Install
+## Installation:
 
-Usage:  `sudo ./install.sh`  **[OPTIONS...]**
+Usage:  `sudo ./install.sh [OPTIONS...]`
 
-*if no option used the terminal user interface will be show up*
+|  Options:              | Description: |
+|:-----------------------|:-------------|
+| -b, --boot             | Install grub theme into `/boot/grub/themes` |
+| -v, --vimix            | Install Vimix grub theme |
+| -s, --stylish          | Install Stylish grub theme |
+| -t, --tela             | Install Tela grub theme |
+| -l, --slaze            | Install Slaze grub theme |
+| -w, --white            | Install using black and white icons |
+| -u, --ultrawide        | Install 21:9 (2560x1080) background image - not available for slaze theme|
+| -C, --custom-background| Use either background.jpg or custom-background.jpg as theme background instead
+| -2, --2k               | Install 2k (2560x1440) background image |
+| -4, --4k               | Install 4k (3840x2160) background image |
+| -r, --remove [THEME]   | Uninstall selected theme |
+| -h, --help             | Show this help |
 
-|  OPTIONS:      | |
-|:---------------|:-------------|
-| -v, --vimix    | Vimix grub theme |
-| -s, --stylish  | Stylish grub theme |
-| -t, --tela     | Tela grub theme |
-| -l, --slaze    | Slaze grub theme |
-| -2, --2k       | Install 2k(2560x1440) background image |
-| -4, --4k       | Install 4k(3840x2160) background image |
-| -r, --remove   | Remove theme (must add theme name option) |
-| -h, --help     | Show this help |
+_If no options are used, a user interface will show up instead_
 
-For example:
-1. `Install Tela theme on 2k display device`
+### Examples:
+ - Install Tela theme on 2k display device:
+   - `sudo ./install.sh --tela --2k`
 
-    sudo ./install.sh -t -2
+ - Install Tela theme into /boot/grub/themes:
+   - `sudo ./install.sh -b -t`
 
-2. `Remove Tela theme`
+ - Uninstall Tela theme:
+   - `sudo ./install.sh -r -t`
 
-    sudo ./install.sh -r -t
+## Issues / tweaks:
 
-## Screenshots
+### Correcting display resolution:
 
-### Vimix grub theme
+ - On the grub screen, press `c` to enter the command line
+ - Enter `vbeinfo` or `videoinfo` to check available resolutions
+ - Open `/etc/default/grub`, and edit `GRUB_GFXMODE=[height]x[width]x32` to match your resolution
+ - Finally, run `grub-mkconfig -o /boot/grub/grub.cfg` to update your grub config
 
-![01](https://github.com/vinceliuice/grub2-themes/blob/master/screenshots/grub-theme-vimix.jpg?raw=true)
+### Setting a custom background:
 
-### Stylish grub theme
+ - Make sure you have `imagemagick` installed, or at least something that provides `convert`
+ - Find the resolution of your display, and make sure your background matches the resolution
+   - (1920x1080 -> --1080p, 2560x1080 -> --ultrawide, 2560x1440 -> --2k, 3840x2160 -> --4k)
+ - Place your custom background inside the root of the project, and name it either background.jpg or custom-background.jpg
+ - Run the installer like normal, but with `--custom-background`, `--[YOUR_RESOLUTION]` and `--[THEME]`
+   - Make sure to replace `[YOUR_RESOLUTION]` with your resolution and `[THEME]` with the theme
 
-![02](https://github.com/vinceliuice/grub2-themes/blob/master/screenshots/grub-theme-stylish.jpg?raw=true)
+## Contributing:
+ - If you made changes to icons, or added a new one:
+   - Delete the existing icon, if there is one
+   - Run `cd assets; ./render-all.sh`
+ - Create a pull request from your branch or fork
+ - If any issues occur, report then to the [issue](https://github.com/vinceliuice/grub2-themes/issues) page
 
-### Tela grub theme
+## Screenshots:
 
-![03](https://github.com/vinceliuice/grub2-themes/blob/master/screenshots/grub-theme-tela.jpg?raw=true)
+### Vimix grub theme:
 
-### Slaze grub theme
+![Vimix](screenshots/grub-theme-vimix.jpg?raw=true)
 
-![04](https://github.com/vinceliuice/grub2-themes/blob/master/screenshots/grub-theme-slaze.jpg?raw=true)
+### Stylish grub theme:
+
+![Stylish](screenshots/grub-theme-stylish.jpg?raw=true)
+
+### Tela grub theme:
+
+![Tela](screenshots/grub-theme-tela.jpg?raw=true)
+
+### Slaze grub theme:
+
+![Slaze](screenshots/grub-theme-slaze.jpg?raw=true)