Compare commits
No commits in common. "master" and "2021-12-05" have entirely different histories.
master
...
2021-12-05
100
README.md
@ -1,102 +1,47 @@
|
|||||||

|

|
||||||
|
|
||||||
## Installation:
|
## Installation:
|
||||||
|
|
||||||
Usage: `sudo ./install.sh [OPTIONS...]`
|
Usage: `sudo ./install.sh [OPTIONS...]`
|
||||||
```
|
|
||||||
-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)
|
|
||||||
-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'
|
| Options: | Description: |
|
||||||
-g, --generate do not install but generate theme into chosen directory (must add your directory)
|
|:-----------------------|:-------------|
|
||||||
|
| -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 |
|
||||||
|
|
||||||
-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
|
- `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:
|
|
||||||
```sh
|
|
||||||
sudo ./install.sh -b -t tela
|
|
||||||
```
|
|
||||||
- Uninstall Tela theme:
|
|
||||||
```sh
|
|
||||||
sudo ./install.sh -r -t tela
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installation with NixOS:
|
- Install Tela theme into /boot/grub/themes:
|
||||||
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.
|
- `sudo ./install.sh -b -t tela`
|
||||||
First you will have to add grub2 to your `flake.nix` file as a new input.
|
|
||||||
```nix
|
- Uninstall Tela theme:
|
||||||
# flake.nix
|
- `sudo ./install.sh -r -t tela`
|
||||||
{
|
|
||||||
description = "NixOS configuration";
|
|
||||||
inputs = {
|
|
||||||
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
|
|
||||||
# Add grub2 themes to your inputs ...
|
|
||||||
grub2-themes = {
|
|
||||||
url = "github:vinceliuice/grub2-themes";
|
|
||||||
};
|
|
||||||
};
|
|
||||||
outputs = inputs@{ nixpkgs, grub2-themes, ... }: {
|
|
||||||
nixosConfigurations = {
|
|
||||||
my_host = nixpkgs.lib.nixosSystem {
|
|
||||||
system = "x86_64-linux";
|
|
||||||
specialArgs = { inherit inputs; };
|
|
||||||
# ... and then to your modules
|
|
||||||
modules = [
|
|
||||||
./configuration.nix
|
|
||||||
grub2-themes.nixosModules.default
|
|
||||||
];
|
|
||||||
};
|
|
||||||
};
|
|
||||||
};
|
|
||||||
}
|
|
||||||
```
|
|
||||||
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
|
|
||||||
# configuration.nix
|
|
||||||
{ inputs, config, pkgs, lib, ... }:
|
|
||||||
{
|
|
||||||
boot.loader.grub = { ... };
|
|
||||||
boot.loader.grub2-theme = {
|
|
||||||
enable = true;
|
|
||||||
theme = "stylish";
|
|
||||||
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, 2560x1080 -> --ultrawide, 2560x1440 -> --2k, 3440x1440 -> --ultrawide2k, 3840x2160 -> --4k)
|
||||||
- 2560x1080 >> ultrawide
|
|
||||||
- 2560x1440 >> 2k
|
|
||||||
- 3440x1440 >> ultrawide2k
|
|
||||||
- 3840x2160 >> 4k
|
|
||||||
- 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:
|
||||||
@ -110,6 +55,7 @@ After that, you can configure the theme as shown below. In this example it is in
|
|||||||
|
|
||||||
## Documents
|
## Documents
|
||||||
|
|
||||||
[Grub2 theme reference](https://wiki.rosalab.ru/en/index.php/Grub2_theme_/_reference)
|
[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)
|
||||||
|
|
||||||
[Grub2 theme tutorial](https://wiki.rosalab.ru/en/index.php/Grub2_theme_tutorial)
|
|
||||||
|
Before Width: | Height: | Size: 527 B After Width: | Height: | Size: 527 B |
Before Width: | Height: | Size: 527 B After Width: | Height: | Size: 527 B |
Before Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 794 B |
Before Width: | Height: | Size: 1.2 KiB |
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 964 B |
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 527 B After Width: | Height: | Size: 527 B |
Before Width: | Height: | Size: 527 B After Width: | Height: | Size: 527 B |
Before Width: | Height: | Size: 1023 B |
Before Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 1.3 KiB |
Before Width: | Height: | Size: 584 B After Width: | Height: | Size: 708 B |
Before Width: | Height: | Size: 770 B After Width: | Height: | Size: 763 B |
Before Width: | Height: | Size: 770 B After Width: | Height: | Size: 763 B |
Before Width: | Height: | Size: 1.6 KiB |
Before Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 1.7 KiB |
Before Width: | Height: | Size: 2.4 KiB After Width: | Height: | Size: 1.4 KiB |
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 1.6 KiB |
Before Width: | Height: | Size: 770 B After Width: | Height: | Size: 763 B |
Before Width: | Height: | Size: 770 B After Width: | Height: | Size: 763 B |
Before Width: | Height: | Size: 1.5 KiB |
Before Width: | Height: | Size: 1.7 KiB |
Before Width: | Height: | Size: 2.0 KiB |
Before Width: | Height: | Size: 871 B After Width: | Height: | Size: 974 B |
Before Width: | Height: | Size: 1005 B After Width: | Height: | Size: 1006 B |
Before Width: | Height: | Size: 1005 B After Width: | Height: | Size: 1006 B |
Before Width: | Height: | Size: 2.2 KiB |
Before Width: | Height: | Size: 1.5 KiB |
Before Width: | Height: | Size: 2.3 KiB |
Before Width: | Height: | Size: 3.5 KiB After Width: | Height: | Size: 1.8 KiB |
Before Width: | Height: | Size: 2.6 KiB After Width: | Height: | Size: 2.1 KiB |
Before Width: | Height: | Size: 1005 B After Width: | Height: | Size: 1006 B |
Before Width: | Height: | Size: 1005 B After Width: | Height: | Size: 1006 B |
Before Width: | Height: | Size: 2.0 KiB |
Before Width: | Height: | Size: 2.2 KiB |
Before Width: | Height: | Size: 2.7 KiB |
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.3 KiB |
Before Width: | Height: | Size: 414 B |
Before Width: | Height: | Size: 549 B |
Before Width: | Height: | Size: 646 B |
Before Width: | Height: | Size: 638 B After Width: | Height: | Size: 436 B |
Before Width: | Height: | Size: 608 B |
Before Width: | Height: | Size: 588 B |
Before Width: | Height: | Size: 641 B |
Before Width: | Height: | Size: 154 B After Width: | Height: | Size: 234 B |
Before Width: | Height: | Size: 599 B |
Before Width: | Height: | Size: 756 B |
Before Width: | Height: | Size: 1016 B |
Before Width: | Height: | Size: 1013 B After Width: | Height: | Size: 650 B |
Before Width: | Height: | Size: 916 B |
Before Width: | Height: | Size: 889 B |
Before Width: | Height: | Size: 1.0 KiB |
Before Width: | Height: | Size: 229 B After Width: | Height: | Size: 304 B |
Before Width: | Height: | Size: 819 B |
Before Width: | Height: | Size: 996 B |
Before Width: | Height: | Size: 1.3 KiB |
Before Width: | Height: | Size: 1.4 KiB After Width: | Height: | Size: 871 B |
Before Width: | Height: | Size: 1.2 KiB |
Before Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 1.4 KiB |
Before Width: | Height: | Size: 232 B After Width: | Height: | Size: 396 B |
Before Width: | Height: | Size: 587 B After Width: | Height: | Size: 582 B |
Before Width: | Height: | Size: 587 B After Width: | Height: | Size: 582 B |
Before Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 679 B |
Before Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 969 B |
Before Width: | Height: | Size: 587 B After Width: | Height: | Size: 582 B |
Before Width: | Height: | Size: 587 B After Width: | Height: | Size: 582 B |
Before Width: | Height: | Size: 1.0 KiB |
Before Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 590 B After Width: | Height: | Size: 783 B |
Before Width: | Height: | Size: 822 B After Width: | Height: | Size: 803 B |
Before Width: | Height: | Size: 822 B After Width: | Height: | Size: 803 B |
Before Width: | Height: | Size: 1.6 KiB |
Before Width: | Height: | Size: 1016 B |
Before Width: | Height: | Size: 1.7 KiB |
Before Width: | Height: | Size: 2.6 KiB After Width: | Height: | Size: 1.4 KiB |
Before Width: | Height: | Size: 822 B After Width: | Height: | Size: 803 B |
Before Width: | Height: | Size: 822 B After Width: | Height: | Size: 803 B |
Before Width: | Height: | Size: 1.5 KiB |
Before Width: | Height: | Size: 1.6 KiB |
Before Width: | Height: | Size: 1.8 KiB |
Before Width: | Height: | Size: 967 B After Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 994 B After Width: | Height: | Size: 987 B |
Before Width: | Height: | Size: 994 B After Width: | Height: | Size: 987 B |
Before Width: | Height: | Size: 2.2 KiB |
Before Width: | Height: | Size: 1.3 KiB |
Before Width: | Height: | Size: 2.2 KiB |
Before Width: | Height: | Size: 3.7 KiB After Width: | Height: | Size: 1.9 KiB |
Before Width: | Height: | Size: 994 B After Width: | Height: | Size: 987 B |
Before Width: | Height: | Size: 994 B After Width: | Height: | Size: 987 B |
Before Width: | Height: | Size: 1.9 KiB |
Before Width: | Height: | Size: 2.0 KiB |
Before Width: | Height: | Size: 2.4 KiB |
Before Width: | Height: | Size: 1.0 KiB After Width: | Height: | Size: 1.3 KiB |