grub2-themes/README.md

79 lines
2.6 KiB
Markdown
Raw Normal View History

2021-11-04 09:49:02 +01:00
![banner](banner.png?raw=true)
## Installation:
2019-06-08 04:49:28 +02:00
2020-01-25 16:13:33 +01:00
Usage: `sudo ./install.sh [OPTIONS...]`
2019-06-08 04:49:28 +02:00
2022-10-30 16:39:27 +01:00
```
-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)
-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)
-h, --help Show this help
```
2021-01-25 17:01:12 +01:00
_If no options are used, a user interface `dialog` will show up instead_
### Examples:
- Install Tela theme on 2k display device:
2022-10-30 16:41:38 +01:00
```sh
sudo ./install.sh -t tela -s 2k
```
- Install Tela theme into /boot/grub/themes:
2022-10-30 16:41:38 +01:00
```sh
sudo ./install.sh -b -t tela
```
- Uninstall Tela theme:
2022-10-30 16:41:38 +01:00
```sh
sudo ./install.sh -r -t tela
```
## Issues / tweaks:
2020-01-25 16:13:33 +01:00
### 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
2020-01-25 16:13:33 +01:00
### Setting a custom background:
2020-01-25 16:13:33 +01:00
- 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
2022-10-30 16:49:02 +01:00
- 1920x1080 >> 1080p
- 2560x1080 >> ultrawide
- 2560x1440 >> 2k
- 3440x1440 >> ultrawide2k
- 3840x2160 >> 4k
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]`
2022-10-30 16:49:02 +01: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:
2022-10-30 16:49:02 +01:00
- 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
2019-11-09 01:00:53 +01:00
2021-11-04 09:16:47 +01:00
## Preview:
Images shown: tela/vimix/stylish/whitesur
2021-11-04 09:16:47 +01:00
![preview](preview.png?raw=true)
2021-05-09 15:21:29 +02:00
## Documents
2021-11-04 08:43:43 +01:00
2021-11-04 08:44:32 +01:00
[Grub2 theme reference](http://wiki.rosalab.ru/en/index.php/Grub2_theme_/_reference)
2021-11-04 08:43:43 +01:00
2021-11-04 08:44:32 +01:00
[Grub2 theme tutorial](http://wiki.rosalab.ru/en/index.php/Grub2_theme_tutorial)
2021-11-04 08:43:43 +01:00