Merge pull request #196 from Maik93/master

improve grub.bak existance check

README.md

@@ -1,54 +1,77 @@
-```
-  ____ ____  _   _ ____ ____    _____ _   _ _____ __  __ _____ ____
- / ___|  _ \| | | | __ )___ \  |_   _| | | | ____|  \/  | ____/ ___|
-| |  _| |_) | | | |  _ \ __) |   | | | |_| |  _| | |\/| |  _| \___ \
-| |_| |  _ <| |_| | |_) / __/    | | |  _  | |___| |  | | |___ ___) |
- \____|_| \_\\___/|____/_____|   |_| |_| |_|_____|_|  |_|_____|____/
+![banner](banner.png?raw=true)
+
+## Installation:
+
+Usage:  `sudo ./install.sh [OPTIONS...]`
 
 ```
+  -t, --theme     theme variant(s)          [tela|vimix|stylish|whitesur]       (default is tela)
+  -i, --icon      icon variant(s)           [color|white|whitesur]              (default is color)
+  -s, --screen    screen display variant(s) [1080p|2k|4k|ultrawide|ultrawide2k] (default is 1080p)
+  -r, --remove    Remove theme              [tela|vimix|stylish|whitesur]       (must add theme name option, default is tela)
 
-## Flat Design themes for Grub2.
+  -b, --boot      install theme into '/boot/grub' or '/boot/grub2'
+  -g, --generate  do not install but generate theme into chosen directory       (must add your directory)
 
-## Install
+  -h, --help      Show this help
+```
 
-Usage:  `sudo ./install.sh`  **[OPTIONS...]**
+_If no options are used, a user interface `dialog` will show up instead_
 
-*if no option used the terminal user interface will be show up*
+### Examples:
+ - Install Tela theme on 2k display device:
 
-|  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 |
+```sh
+sudo ./install.sh -t tela -s 2k
+```
 
-For example:
-1. `Install Tela theme on 2k display device`
+ - Install Tela theme into /boot/grub/themes:
 
-    sudo ./install.sh -t -2
+```sh
+sudo ./install.sh -b -t tela
+```
 
-2. `Remove Tela theme`
+ - Uninstall Tela theme:
 
-    sudo ./install.sh -r -t
+```sh
+sudo ./install.sh -r -t tela
+```
 
-## Screenshots
+## Issues / tweaks:
 
-### Vimix grub theme
+### Correcting display resolution:
 
-![01](https://github.com/vinceliuice/grub2-themes/blob/master/screenshots/grub-theme-vimix.jpg?raw=true)
+ - 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
 
-### Stylish grub theme
+### Setting a custom background:
 
-![02](https://github.com/vinceliuice/grub2-themes/blob/master/screenshots/grub-theme-stylish.jpg?raw=true)
+ - 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
+   - 3440x1440 >> ultrawide2k
+   - 3840x2160 >> 4k
+ - Place your custom background inside the root of the project, and name it `background.jpg`
+ - Run the installer like normal, but with -s `[YOUR_RESOLUTION]` and -t `[THEME]` and -i `[ICON]`
+   - Make sure to replace `[YOUR_RESOLUTION]` with your resolution and `[THEME]` with the theme
 
-### Tela grub theme
+## 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
 
-![03](https://github.com/vinceliuice/grub2-themes/blob/master/screenshots/grub-theme-tela.jpg?raw=true)
+## Preview:
+![preview](preview.png?raw=true)
 
-### Slaze grub theme
+## Documents
+
+[Grub2 theme reference](http://wiki.rosalab.ru/en/index.php/Grub2_theme_/_reference)
+
+[Grub2 theme tutorial](http://wiki.rosalab.ru/en/index.php/Grub2_theme_tutorial)
 
-![04](https://github.com/vinceliuice/grub2-themes/blob/master/screenshots/grub-theme-slaze.jpg?raw=true)