grub2-themes/README.md

```
  ____ ____  _   _ ____ ____    _____ _   _ _____ __  __ _____ ____
 / ___|  _ \| | | | __ )___ \  |_   _| | | | ____|  \/  | ____/ ___|
| |  _| |_) | | | |  _ \ __) |   | | | |_| |  _| | |\/| |  _| \___ \
| |_| |  _ <| |_| | |_) / __/    | | |  _  | |___| |  | | |___ ___) |
 \____|_| \_\\___/|____/_____|   |_| |_| |_|_____|_|  |_|_____|____/

```

## Flat Design themes for Grub

## Installation:

Usage:  `sudo ./install.sh [OPTIONS...]`

|  Options:              | Description: |
|:-----------------------|:-------------|
| -b, --boot             | Install grub theme into `/boot/grub/themes` |
| -t, --theme            | theme variant(s) [tela/vimix/stylish/slaze/whitesur] (default is tela)"
| -i, --icon             | icon variant(s) [color/white/whitesur] (default is color)"
| -s, --screen           | screen resolution variant(s) [1080p/2k/4k/ultrawide/ultrawide2k] (default is 1080p)"
| -r, --remove [THEME]   | Uninstall selected theme |
| -h, --help             | Show this help |

_If no options are used, a user interface `dialog` will show up instead_

### Examples:
 - Install Tela theme on 2k display device:
   - `sudo ./install.sh -t tela -s 2k`

 - Install Tela theme into /boot/grub/themes:
   - `sudo ./install.sh -b -t tela`

 - Uninstall Tela theme:
   - `sudo ./install.sh -r -t tela`

## Issues / tweaks:

### Correcting display resolution:

 - 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

### Setting a custom background:

 - 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

## 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

## Screenshots:

### Vimix grub theme:

![Vimix](screenshots/grub-theme-vimix.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)

## 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)
Grub theme : :arrow_up: install.sh update and README file Features : :children_crossing: + adding terminal user interface for better use + persited exectution of the script as root + adding color syntax information 2019-06-08 01:30:45 +02:00			```
update 2019-06-08 04:49:28 +02:00			`____ ____ _ _ ____ ____ _____ _ _ _____ __ __ _____ ____`
			`/ ___\| _ \\| \| \| \| __ )___ \ \|_ _\| \| \| \| ____\| \/ \| ____/ ___\|`
			`\| \| _\| \|_) \| \| \| \| _ \ __) \| \| \| \| \|_\| \| _\| \| \|\/\| \| _\| \___ \`
Grub theme : :arrow_up: install.sh update and README file Features : :children_crossing: + adding terminal user interface for better use + persited exectution of the script as root + adding color syntax information 2019-06-08 01:30:45 +02:00			`\| \|_\| \| _ <\| \|_\| \| \|_) / __/ \| \| \| _ \| \|___\| \| \| \| \|___ ___) \|`
update 2019-06-08 04:49:28 +02:00			`\____\|_\| \_\\___/\|____/_____\| \|_\| \|_\| \|_\|_____\|_\| \|_\|_____\|____/`
upload upload 2017-12-19 05:17:31 +01:00
update 2019-06-08 04:49:28 +02:00			```
upload upload 2017-12-19 05:17:31 +01:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`## Flat Design themes for Grub`
upload upload 2017-12-19 05:17:31 +01:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`## Installation:`
update 2019-06-08 04:49:28 +02:00
style-rule changes on README.md 2020-01-25 16:13:33 +01:00			Usage: `sudo ./install.sh [OPTIONS...]`
update 2019-06-08 04:49:28 +02:00
Document new --custom-background option 2020-10-16 22:59:12 +02:00			`\| Options: \| Description: \|`
			`\|:-----------------------\|:-------------\|`
			\| -b, --boot \| Install grub theme into `/boot/grub/themes` \|
Update README.md 2021-01-25 17:01:12 +01:00			`\| -t, --theme \| theme variant(s) [tela/vimix/stylish/slaze/whitesur] (default is tela)"`
			`\| -i, --icon \| icon variant(s) [color/white/whitesur] (default is color)"`
			`\| -s, --screen \| screen resolution variant(s) [1080p/2k/4k/ultrawide/ultrawide2k] (default is 1080p)"`
Document new --custom-background option 2020-10-16 22:59:12 +02:00			`\| -r, --remove [THEME] \| Uninstall selected theme \|`
			`\| -h, --help \| Show this help \|`
Add 2k and 4k background image for grub theme 2019-10-01 08:59:14 +02:00
Update README.md 2021-01-25 17:01:12 +01:00			_If no options are used, a user interface `dialog` will show up instead_
Add remove option and fixed install issues 2019-10-25 11:52:53 +02:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`### Examples:`
Added a contributing section, improved documentation on custom backgrounds and fixed speling mistakes / typos 2020-10-17 12:12:09 +02:00			`- Install Tela theme on 2k display device:`
Update README.md 2021-01-25 17:01:12 +01:00			- `sudo ./install.sh -t tela -s 2k`
Add remove option and fixed install issues 2019-10-25 11:52:53 +02:00
Added a contributing section, improved documentation on custom backgrounds and fixed speling mistakes / typos 2020-10-17 12:12:09 +02:00			`- Install Tela theme into /boot/grub/themes:`
Update README.md 2021-01-25 17:01:12 +01:00			- `sudo ./install.sh -b -t tela`
Add option for theme install into /boot/grub/themes 2020-03-30 06:59:37 +02:00
Added a contributing section, improved documentation on custom backgrounds and fixed speling mistakes / typos 2020-10-17 12:12:09 +02:00			`- Uninstall Tela theme:`
Update README.md 2021-01-25 17:01:12 +01:00			- `sudo ./install.sh -r -t tela`
Add option for theme install into /boot/grub/themes 2020-03-30 06:59:37 +02:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`## Issues / tweaks:`
style-rule changes on README.md 2020-01-25 16:13:33 +01:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`### Correcting display resolution:`
Add 2k and 4k background image for grub theme 2019-10-01 08:59:14 +02:00
Added a contributing section, improved documentation on custom backgrounds and fixed speling mistakes / typos 2020-10-17 12:12:09 +02:00			- On the grub screen, press `c` to enter the command line
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			- 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
style-rule changes on README.md 2020-01-25 16:13:33 +01:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`### Setting a custom background:`
style-rule changes on README.md 2020-01-25 16:13:33 +01:00
Document imagemagick as required dependency 2020-10-17 16:14:09 +02:00			- Make sure you have `imagemagick` installed, or at least something that provides `convert`
Added a contributing section, improved documentation on custom backgrounds and fixed speling mistakes / typos 2020-10-17 12:12:09 +02:00			`- Find the resolution of your display, and make sure your background matches the resolution`
Added 1440p ultrawide documentation 2021-01-07 23:28:38 +01:00			`- (1920x1080 -> --1080p, 2560x1080 -> --ultrawide, 2560x1440 -> --2k, 3440x1440 -> --ultrawide2k, 3840x2160 -> --4k)`
Update README.md 2021-01-25 17:01:12 +01:00			- 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]`
Added a contributing section, improved documentation on custom backgrounds and fixed speling mistakes / typos 2020-10-17 12:12:09 +02:00			- Make sure to replace `[YOUR_RESOLUTION]` with your resolution and `[THEME]` with the 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`
update 2019-11-09 01:00:53 +01:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`## Screenshots:`
update 2019-05-31 09:54:54 +02:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`### Vimix grub theme:`
update 2019-05-31 09:54:54 +02:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`![Vimix](screenshots/grub-theme-vimix.jpg?raw=true)`
update 2019-05-31 09:54:54 +02:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`### Stylish grub theme:`
update 2019-05-31 09:54:54 +02:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`![Stylish](screenshots/grub-theme-stylish.jpg?raw=true)`
update 2019-05-31 09:54:54 +02:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`### Tela grub theme:`
update 2019-05-31 09:54:54 +02:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`![Tela](screenshots/grub-theme-tela.jpg?raw=true)`
update 2019-05-31 09:54:54 +02:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`### Slaze grub theme:`
update 2019-05-31 09:54:54 +02:00
Improved clarity of README, added section on custom wallpapers and reformatted most of it 2020-10-16 18:40:48 +02:00			`![Slaze](screenshots/grub-theme-slaze.jpg?raw=true)`
Fixed #124 2021-05-09 15:21:29 +02:00
			`## Documents`
Update README.md 2021-11-04 08:43:43 +01:00
Update README.md 2021-11-04 08:44:32 +01:00			`[Grub2 theme reference](http://wiki.rosalab.ru/en/index.php/Grub2_theme_/_reference)`
Update README.md 2021-11-04 08:43:43 +01:00
Update README.md 2021-11-04 08:44:32 +01:00			`[Grub2 theme tutorial](http://wiki.rosalab.ru/en/index.php/Grub2_theme_tutorial)`
Update README.md 2021-11-04 08:43:43 +01:00