elie/grub2-themes
1
0
Fork 0
mirror of https://github.com/vinceliuice/grub2-themes.git synced 2024-11-05 11:26:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Zhiyong (Justin) He 2024-09-17 20:20:35 +03:00 committed by GitHub
parent 326a27a6f2
commit 18ea3defc5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -1,51 +1,46 @@
![banner](banner.png?raw=true) ![banner](banner.png?raw=true)
## Installation: ## Installation:
Usage: `sudo ./install.sh [OPTIONS...]` Usage: `sudo ./install.sh [OPTIONS...]`
``` ```
-t, --theme theme variant(s) [tela|vimix|stylish|whitesur] (default is tela) -t, --theme theme variant(s) [tela|vimix|stylish|whitesur] (default is tela)
-i, --icon icon variant(s) [color|white|whitesur] (default is color) -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) -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) -c, --custom-resolution set custom resolution (e.g., 1600x900) (disabled in default)
-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' -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) -g, --generate do not install but generate theme into chosen directory (must add your directory)
-h, --help Show this help -h, --help Show this help
``` ```
*If no options are used, a user interface *`dialog`* 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:
```sh ```sh
sudo ./install.sh -t tela -s 2k sudo ./install.sh -t tela -s 2k
``` ```
- Install Tela theme with custom resolution:
```sh
sudo ./install.sh -t tela -c 1600x900
```
- Install Tela theme into /boot/grub/themes: - Install Tela theme into /boot/grub/themes:
```sh ```sh
sudo ./install.sh -b -t tela sudo ./install.sh -b -t tela
``` ```
- Uninstall Tela theme: - Uninstall Tela theme:
```sh ```sh
sudo ./install.sh -r -t tela sudo ./install.sh -r -t tela
``` ```
## Installation with NixOS: ## Installation with NixOS:
To use this theme with NixOS you will have to enable [flakes](https://wiki.nixos.org/wiki/flakes). Before you do this, please inform yourself if you really want to, because flakes are still an unstable feature. To use this theme with NixOS you will have to enable [flakes](https://wiki.nixos.org/wiki/flakes). Before you do this, please inform yourself if you really want to, because flakes are still an unstable feature.
First you will have to add grub2 to your `flake.nix` file as a new input. First you will have to add grub2 to your `flake.nix` file as a new input.
```nix ```nix
# flake.nix # flake.nix
{ {
description = "NixOS configuration"; description = "NixOS configuration";
inputs = { inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
# Add grub2 themes to your inputs ... # Add grub2 themes to your inputs ...
@ -53,13 +48,11 @@ First you will have to add grub2 to your `flake.nix` file as a new input.
url = "github:vinceliuice/grub2-themes"; url = "github:vinceliuice/grub2-themes";
}; };
}; };
outputs = inputs@{ nixpkgs, grub2-themes, ... }: { outputs = inputs@{ nixpkgs, grub2-themes, ... }: {
nixosConfigurations = { nixosConfigurations = {
my_host = nixpkgs.lib.nixosSystem { my_host = nixpkgs.lib.nixosSystem {
system = "x86_64-linux"; system = "x86_64-linux";
specialArgs = { inherit inputs; }; specialArgs = { inherit inputs; };
# ... and then to your modules # ... and then to your modules
modules = [ modules = [
./configuration.nix ./configuration.nix
@ -70,7 +63,6 @@ First you will have to add grub2 to your `flake.nix` file as a new input.
}; };
} }
``` ```
After that, you can configure the theme as shown below. In this example it is inside the `configuration.nix` file but it can be any file you choose. After that, you can configure the theme as shown below. In this example it is inside the `configuration.nix` file but it can be any file you choose.
```nix ```nix
# configuration.nix # configuration.nix
@ -81,21 +73,19 @@ After that, you can configure the theme as shown below. In this example it is in
enable = true; enable = true;
theme = "stylish"; theme = "stylish";
footer = true; footer = true;
customResolution = "1600x900"; # Optional: Set a custom resolution
}; };
} }
``` ```
## Issues / tweaks: ## Issues / tweaks:
### Correcting display resolution: ### Correcting display resolution:
- On the grub screen, press `c` to enter the command line - On the grub screen, press `c` to enter the command line
- Enter `vbeinfo` or `videoinfo` to check available resolutions - Enter `vbeinfo` or `videoinfo` to check available resolutions
- Open `/etc/default/grub`, and edit `GRUB_GFXMODE=[height]x[width]x32` to match your resolution - 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 - Finally, run `grub-mkconfig -o /boot/grub/grub.cfg` to update your grub config
### Setting a custom background: ### Setting a custom background:
- 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 - 1920x1080 >> 1080p
@ -106,6 +96,7 @@ After that, you can configure the theme as shown below. In this example it is in
- Place your custom background inside the root of the project, and name it `background.jpg` - 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]` - 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
- Alternatively, use the `-c` option to set a custom resolution
## Contributing: ## Contributing:
- If you made changes to icons, or added a new one: - If you made changes to icons, or added a new one:
@ -118,7 +109,5 @@ After that, you can configure the theme as shown below. In this example it is in
![preview](preview.png?raw=true) ![preview](preview.png?raw=true)
## Documents ## Documents
[Grub2 theme reference](https://wiki.rosalab.ru/en/index.php/Grub2_theme_/_reference)
[Grub2 theme reference](https://wiki.rosalab.ru/en/index.php/Grub2_theme_/_reference)
[Grub2 theme tutorial](https://wiki.rosalab.ru/en/index.php/Grub2_theme_tutorial) [Grub2 theme tutorial](https://wiki.rosalab.ru/en/index.php/Grub2_theme_tutorial)