luisgulo/grub2-themes
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
vinceliuice 2021-01-26 00:01:12 +08:00
parent 30c1a9162b
commit 41807fe458
1 changed files with 9 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -16,30 +16,23 @@ Usage: `sudo ./install.sh [OPTIONS...]`
| Options: | Description: | | Options: | Description: |
|:-----------------------|:-------------| |:-----------------------|:-------------|
| -b, --boot | Install grub theme into `/boot/grub/themes` | | -b, --boot | Install grub theme into `/boot/grub/themes` |
| -v, --vimix | Install Vimix grub theme | | -t, --theme | theme variant(s) [tela/vimix/stylish/slaze/whitesur] (default is tela)"
| -s, --stylish | Install Stylish grub theme | | -i, --icon | icon variant(s) [color/white/whitesur] (default is color)"
| -t, --tela | Install Tela grub theme | | -s, --screen | screen resolution variant(s) [1080p/2k/4k/ultrawide/ultrawide2k] (default is 1080p)"
| -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|
| -U, --ultrawide2k | Install 21:9 (3440x1440) 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 | | -r, --remove [THEME] | Uninstall selected theme |
| -h, --help | Show this help | | -h, --help | Show this help |
_If no options are used, a user interface will show up instead_ _If no options are used, a user interface `dialog` will show up instead_
### Examples: ### Examples:
- Install Tela theme on 2k display device: - Install Tela theme on 2k display device:
- `sudo ./install.sh --tela --2k` - `sudo ./install.sh -t tela -s 2k`
- Install Tela theme into /boot/grub/themes: - Install Tela theme into /boot/grub/themes:
- `sudo ./install.sh -b -t` - `sudo ./install.sh -b -t tela`
- Uninstall Tela theme: - Uninstall Tela theme:
- `sudo ./install.sh -r -t` - `sudo ./install.sh -r -t tela`
## Issues / tweaks: ## Issues / tweaks:
@ -55,8 +48,8 @@ _If no options are used, a user interface will show up instead_
- Make sure you have `imagemagick` installed, or at least something that provides `convert` - 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 - Find the resolution of your display, and make sure your background matches the resolution
- (1920x1080 -> --1080p, 2560x1080 -> --ultrawide, 2560x1440 -> --2k, 3440x1440 -> --ultrawide2k, 3840x2160 -> --4k) - (1920x1080 -> --1080p, 2560x1080 -> --ultrawide, 2560x1440 -> --2k, 3440x1440 -> --ultrawide2k, 3840x2160 -> --4k)
- Place your custom background inside the root of the project, and name it either background.jpg or custom-background.jpg - Place your custom background inside the root of the project, and name it `background.jpg`
- Run the installer like normal, but with `--custom-background`, `--[YOUR_RESOLUTION]` and `--[THEME]` - 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 - Make sure to replace `[YOUR_RESOLUTION]` with your resolution and `[THEME]` with the theme
## Contributing: ## Contributing: