grub2-themes/README.md
2021-12-05 14:18:39 +08:00

62 lines
2.4 KiB
Markdown

![banner](banner.png?raw=true)
## 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/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
## Preview:
![preview](preview.png?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)