From bc8747f28646645aeb47c4689d8a81232cd87c92 Mon Sep 17 00:00:00 2001 From: Stuart Hayhurst Date: Fri, 16 Oct 2020 17:40:48 +0100 Subject: [PATCH 1/3] Improved clarity of README, added section on custom wallpapers and reformatted most of it --- README.md | 85 +++++++++++++++++--------------- backgrounds/Add_Custom_Wallpaper | 13 ----- 2 files changed, 44 insertions(+), 54 deletions(-) delete mode 100644 backgrounds/Add_Custom_Wallpaper diff --git a/README.md b/README.md index 7dd43e1..3cbd64a 100644 --- a/README.md +++ b/README.md @@ -7,66 +7,69 @@ ``` -## Flat Design themes for Grub2. +## Flat Design themes for Grub -**If you want to use Custom Wallpapers read the "Add_Custom_Wallpaper" file in the backgrounds folder** - -## Install +## Installation: Usage: `sudo ./install.sh [OPTIONS...]` -_if no option used the terminal user interface will be show up_ +| Options: | Description: | +|:--------------------|:-------------| +| -b, --boot | Install grub theme into `/boot/grub/themes` | +| -v, --vimix | Install Vimix grub theme | +| -s, --stylish | Install Stylish grub theme | +| -t, --tela | Install Tela grub theme | +| -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| +| -2, --2k | Install 2k (2560x1440) background image | +| -4, --4k | Install 4k (3840x2160) background image | +| -r, --remove [THEME]| Uninstall selected theme | +| -h, --help | Show this help | -| OPTIONS: | description | -|:-------------------|:-------------| -| -b, --boot | Install grub theme into /boot/grub/themes | -| -v, --vimix | Vimix grub theme | -| -s, --stylish | Stylish grub theme | -| -t, --tela | Tela grub theme | -| -l, --slaze | Slaze grub theme | -| -w, --white | Install white color icon version | -| -u, --ultrawide | Install 2560x1080 background image - not available for slaze theme| -| -2, --2k | Install 2k(2560x1440) background image | -| -4, --4k | Install 4k(3840x2160) background image | -| -r, --remove | Remove theme (must add theme name option) | -| -h, --help | Show this help | +_If no options are used, a user interface will show up instead_ -For example: +### Examples: + - Install Tela theme on 2k display device: + - `sudo ./install.sh --tela --2k` -1. Install Tela theme on 2k display device + - Install Tela theme into /boot/grub/themes: + - `sudo ./install.sh -b -t` - `sudo ./install.sh -t -2` - or - `sudo ./install.sh --tela --2k` + - Uninstall Tela theme: + - `sudo ./install.sh -r -t` -2. Install Tela theme into /boot/grub/themes +## Issues / tweaks: - `sudo ./install.sh -b -t` +### Correcting display resolution: -3. Remove Tela theme + - On the grub screen, precc `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 - `sudo ./install.sh -r -t` +### Setting a custom background: -## Display resolution issues + - Find the resolution of your display (1920x1080 -> 1080p, 2560x1080 -> 1080p_21:9, 2560x1440 -> 2k, 3840x2160 -> 4k) + - Place your custom background inside the correct folder matching your resolution, and make sure it's a .jpg + - Rename the default wallpaper for your chosen theme to something else + - Rename the custom wallpaper to the name of the default wallpaper for your chosen theme + - Run the installer like normal, making sure to select your chosen theme -#### Set the right resolution of your display +## Screenshots: -On the grub screen, `press c` to get the commandline, and enter `vbeinfo` or `videoinfo` on EFI boot to check what resolutions you can use, then edit `/etc/default/grub` , add your resolution `GRUB_GFXMODE=****x****x32` into it, last you can run `grub-mkconfig -o /boot/grub/grub.cfg` to update your grub.cfg. +### Vimix grub theme: -## Screenshots +![Vimix](screenshots/grub-theme-vimix.jpg?raw=true) -### Vimix grub theme +### Stylish grub theme: -![vimix grub theme](screenshots/grub-theme-vimix.jpg?raw=true) +![Stylish](screenshots/grub-theme-stylish.jpg?raw=true) -### Stylish grub theme +### Tela grub theme: -![Stylish grub theme](screenshots/grub-theme-stylish.jpg?raw=true) +![Tela](screenshots/grub-theme-tela.jpg?raw=true) -### Tela grub theme +### Slaze grub theme: -![Tela grub theme](screenshots/grub-theme-tela.jpg?raw=true) - -### Slaze grub theme - -![Slaze grub theme](screenshots/grub-theme-slaze.jpg?raw=true) +![Slaze](screenshots/grub-theme-slaze.jpg?raw=true) diff --git a/backgrounds/Add_Custom_Wallpaper b/backgrounds/Add_Custom_Wallpaper deleted file mode 100644 index 9be6818..0000000 --- a/backgrounds/Add_Custom_Wallpaper +++ /dev/null @@ -1,13 +0,0 @@ -## To Add Custom Wallpapers in Grub themes present ## - -Easiest Method (Other Method is to change the install script but that will waste your time) - -1. First thing is knowing your screen resolution if it is 1920x1080 then go into the folder 1080p. -2. Paste your desired photo inside the folder (in the above example inside 1080p) and make sure it is a jpg file. -3. Let's say now if you want to use Vimix theme, then rename the default wallpaper for that theme to something else (in this case for eg. 1.jpg). -4. Now rename your desired image to the same name as the default wallpaper for that theme was (in our case "background-vimix"). - - - ----------------------------------------------------------------------------------x----------------------------------------------------------------------------------- - From 5dd34a008a339b6311717a6cc7c1bf28fd0da224 Mon Sep 17 00:00:00 2001 From: Stuart Hayhurst Date: Fri, 16 Oct 2020 21:59:12 +0100 Subject: [PATCH 2/3] Document new --custom-background option --- README.md | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 3cbd64a..e89cb25 100644 --- a/README.md +++ b/README.md @@ -13,19 +13,20 @@ Usage: `sudo ./install.sh [OPTIONS...]` -| Options: | Description: | -|:--------------------|:-------------| -| -b, --boot | Install grub theme into `/boot/grub/themes` | -| -v, --vimix | Install Vimix grub theme | -| -s, --stylish | Install Stylish grub theme | -| -t, --tela | Install Tela grub theme | -| -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| -| -2, --2k | Install 2k (2560x1440) background image | -| -4, --4k | Install 4k (3840x2160) background image | -| -r, --remove [THEME]| Uninstall selected theme | -| -h, --help | Show this help | +| Options: | Description: | +|:-----------------------|:-------------| +| -b, --boot | Install grub theme into `/boot/grub/themes` | +| -v, --vimix | Install Vimix grub theme | +| -s, --stylish | Install Stylish grub theme | +| -t, --tela | Install Tela grub theme | +| -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| +| -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 | +| -h, --help | Show this help | _If no options are used, a user interface will show up instead_ @@ -51,10 +52,8 @@ _If no options are used, a user interface will show up instead_ ### Setting a custom background: - Find the resolution of your display (1920x1080 -> 1080p, 2560x1080 -> 1080p_21:9, 2560x1440 -> 2k, 3840x2160 -> 4k) - - Place your custom background inside the correct folder matching your resolution, and make sure it's a .jpg - - Rename the default wallpaper for your chosen theme to something else - - Rename the custom wallpaper to the name of the default wallpaper for your chosen theme - - Run the installer like normal, making sure to select your chosen theme + - Place your custom background inside the root of the project, and name it either background.jpg or custom-background.jpg + - Run the installer like normal, but with `--custom-background` as en extra argument ## Screenshots: From 3d9f7f342545c8b5c964854f4b642e43d4a78eee Mon Sep 17 00:00:00 2001 From: Stuart Hayhurst Date: Sat, 17 Oct 2020 11:12:09 +0100 Subject: [PATCH 3/3] Added a contributing section, improved documentation on custom backgrounds and fixed speling mistakes / typos --- README.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e89cb25..1473446 100644 --- a/README.md +++ b/README.md @@ -31,29 +31,38 @@ Usage: `sudo ./install.sh [OPTIONS...]` _If no options are used, a user interface will show up instead_ ### Examples: - - Install Tela theme on 2k display device: - - `sudo ./install.sh --tela --2k` + - Install Tela theme on 2k display device: + - `sudo ./install.sh --tela --2k` - - Install Tela theme into /boot/grub/themes: - - `sudo ./install.sh -b -t` + - Install Tela theme into /boot/grub/themes: + - `sudo ./install.sh -b -t` - - Uninstall Tela theme: - - `sudo ./install.sh -r -t` + - Uninstall Tela theme: + - `sudo ./install.sh -r -t` ## Issues / tweaks: ### Correcting display resolution: - - On the grub screen, precc `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 - 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: - - Find the resolution of your display (1920x1080 -> 1080p, 2560x1080 -> 1080p_21:9, 2560x1440 -> 2k, 3840x2160 -> 4k) + - Find the resolution of your display, and make sure your background matches the resolution + - (1920x1080 -> --1080p, 2560x1080 -> --ultrawide, 2560x1440 -> --2k, 3840x2160 -> --4k) - Place your custom background inside the root of the project, and name it either background.jpg or custom-background.jpg - - Run the installer like normal, but with `--custom-background` as en extra argument + - Run the installer like normal, but with `--custom-background`, `--[YOUR_RESOLUTION]` and `--[THEME]` + - 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 ## Screenshots: