Update README.md

Ultrawide 2k (3440x1440) support

README.md

@@ -7,64 +7,72 @@
 
 ```
 
-## Flat Design themes for Grub2.
+## Flat Design themes for Grub
 
-## 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` |
+| -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 |
 
-|  OPTIONS:          | description |
+_If no options are used, a user interface `dialog` will show up instead_
-|:-------------------|:-------------|
-| -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 |
 
-For example:
+### Examples:
+ - Install Tela theme on 2k display device:
+   - `sudo ./install.sh -t tela -s 2k`
 
-1. Install Tela theme on 2k display device
+ - Install Tela theme into /boot/grub/themes:
+   - `sudo ./install.sh -b -t tela`
 
-    `sudo ./install.sh -t -2`
+ - Uninstall Tela theme:
-    or
+   - `sudo ./install.sh -r -t tela`
-    `sudo ./install.sh --tela --2k`
 
-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, 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
 
-    `sudo ./install.sh -r -t`
+### Setting a custom background:
 
-## Display resolution issues
+ - 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
 
-#### Set the right resolution of your display
+## 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
 
-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.
+## Screenshots:
 
-## Screenshots
+### Vimix grub theme:
 
-### Vimix grub theme
+![Vimix](screenshots/grub-theme-vimix.jpg?raw=true)
 
-![vimix grub theme](screenshots/grub-theme-vimix.jpg?raw=true)
+### Stylish grub theme:
 
-### Stylish grub theme
+![Stylish](screenshots/grub-theme-stylish.jpg?raw=true)
 
-![Stylish grub theme](screenshots/grub-theme-stylish.jpg?raw=true)
+### Tela grub theme:
 
-### Tela grub theme
+![Tela](screenshots/grub-theme-tela.jpg?raw=true)
 
-![Tela grub theme](screenshots/grub-theme-tela.jpg?raw=true)
+### Slaze grub theme:
 
-### Slaze grub theme
+![Slaze](screenshots/grub-theme-slaze.jpg?raw=true)
-
-![Slaze grub theme](screenshots/grub-theme-slaze.jpg?raw=true)

assets/assets-color/logos.txt

@@ -1,52 +0,0 @@
-antergos
-arcolinux
-elementary
-korora
-mageia
-steamos
-archlinux
-fedora
-freebsd
-kubuntu
-manjaro
-ubuntu
-chakra
-gentoo
-opensuse
-windows
-debian
-parrot
-gnu-linux
-linuxmint
-siduction
-xubuntu
-deepin
-kali
-lubuntu
-solus
-kaos
-void
-macosx
-haiku
-endeavouros
-recovery
-restart
-shutdown
-cancel
-driver
-edit
-efi
-find.efi
-find.none
-help
-kbd
-lang
-type
-tz
-unset
-
-
-
-
-
-

assets/assets-color/render-logos-1080p.sh

@@ -1,35 +0,0 @@
-#! /bin/bash
-
-INKSCAPE="/usr/bin/inkscape"
-OPTIPNG="/usr/bin/optipng"
-
-INDEX="logos.txt"
-ASSETS_DIR="icons-1080p"
-SRC_FILE="logos.svg"
-
-install -d $ASSETS_DIR
-
-for i in `cat $INDEX`
-do
-if [ -f $ASSETS_DIR/$i.png ]; then
-  echo $ASSETS_DIR/$i.png exists.
-else
-  echo
-  echo Rendering $ASSETS_DIR/$i.png
-  $INKSCAPE --export-id=$i \
-            --export-id-only \
-            --export-filename=$ASSETS_DIR/$i.png $SRC_FILE >/dev/null
-  $OPTIPNG -o7 --quiet $ASSETS_DIR/$1.png
-fi
-done
-
-cd $ASSETS_DIR
-cp -a archlinux.png arch.png
-cp -a gnu-linux.png linux.png
-cp -a gnu-linux.png unknown.png
-cp -a gnu-linux.png lfs.png
-cp -a manjaro.png Manjaro.i686.png
-cp -a manjaro.png Manjaro.x86_64.png
-cp -a driver.png memtest.png
-
-exit 0

assets/assets-color/render-logos-2k.sh

@@ -1,36 +0,0 @@
-#! /bin/bash
-
-INKSCAPE="/usr/bin/inkscape"
-OPTIPNG="/usr/bin/optipng"
-
-INDEX="logos.txt"
-ASSETS_DIR="icons-2k"
-SRC_FILE="logos.svg"
-
-install -d $ASSETS_DIR
-
-for i in `cat $INDEX`
-do
-if [ -f $ASSETS_DIR/$i.png ]; then
-  echo $ASSETS_DIR/$i.png exists.
-else
-  echo
-  echo Rendering $ASSETS_DIR/$i.png
-  $INKSCAPE --export-id=$i \
-            --export-dpi=144 \
-            --export-id-only \
-            --export-filename=$ASSETS_DIR/$i.png $SRC_FILE >/dev/null
-  $OPTIPNG -o7 --quiet $ASSETS_DIR/$1.png
-fi
-done
-
-cd $ASSETS_DIR
-cp -a archlinux.png arch.png
-cp -a gnu-linux.png linux.png
-cp -a gnu-linux.png unknown.png
-cp -a gnu-linux.png lfs.png
-cp -a manjaro.png Manjaro.i686.png
-cp -a manjaro.png Manjaro.x86_64.png
-cp -a driver.png memtest.png
-
-exit 0

assets/assets-color/render-logos-4k.sh

@@ -1,36 +0,0 @@
-#! /bin/bash
-
-INKSCAPE="/usr/bin/inkscape"
-OPTIPNG="/usr/bin/optipng"
-
-INDEX="logos.txt"
-ASSETS_DIR="icons-4k"
-SRC_FILE="logos.svg"
-
-install -d $ASSETS_DIR
-
-for i in `cat $INDEX`
-do
-if [ -f $ASSETS_DIR/$i.png ]; then
-  echo $ASSETS_DIR/$i.png exists.
-else
-  echo
-  echo Rendering $ASSETS_DIR/$i.png
-  $INKSCAPE --export-id=$i \
-            --export-dpi=192 \
-            --export-id-only \
-            --export-filename=$ASSETS_DIR/$i.png $SRC_FILE >/dev/null
-  $OPTIPNG -o7 --quiet $ASSETS_DIR/$1.png
-fi
-done
-
-cd $ASSETS_DIR
-cp -a archlinux.png arch.png
-cp -a gnu-linux.png linux.png
-cp -a gnu-linux.png unknown.png
-cp -a gnu-linux.png lfs.png
-cp -a manjaro.png Manjaro.i686.png
-cp -a manjaro.png Manjaro.x86_64.png
-cp -a driver.png memtest.png
-
-exit 0

assets/assets-color/render-select-1080p.sh

@@ -1,26 +0,0 @@
-#! /bin/bash
-
-INKSCAPE="/usr/bin/inkscape"
-OPTIPNG="/usr/bin/optipng"
-
-INDEX="select.txt"
-ASSETS_DIR="select-1080p"
-SRC_FILE="select.svg"
-
-install -d $ASSETS_DIR
-
-for i in `cat $INDEX`
-do
-if [ -f $ASSETS_DIR/$i.png ]; then
-  echo $ASSETS_DIR/$i.png exists.
-else
-  echo
-  echo Rendering $ASSETS_DIR/$i.png
-  $INKSCAPE --export-id=$i \
-            --export-id-only \
-            --export-filename=$ASSETS_DIR/$i.png $SRC_FILE >/dev/null
-  $OPTIPNG -o7 --quiet $ASSETS_DIR/$1.png
-fi
-done
-
-exit 0

assets/assets-color/render-select-2k.sh

@@ -1,27 +0,0 @@
-#! /bin/bash
-
-INKSCAPE="/usr/bin/inkscape"
-OPTIPNG="/usr/bin/optipng"
-
-INDEX="select.txt"
-ASSETS_DIR="select-2k"
-SRC_FILE="select.svg"
-
-install -d $ASSETS_DIR
-
-for i in `cat $INDEX`
-do
-if [ -f $ASSETS_DIR/$i.png ]; then
-  echo $ASSETS_DIR/$i.png exists.
-else
-  echo
-  echo Rendering $ASSETS_DIR/$i.png
-  $INKSCAPE --export-id=$i \
-            --export-dpi=144 \
-            --export-id-only \
-            --export-filename=$ASSETS_DIR/$i.png $SRC_FILE >/dev/null
-  $OPTIPNG -o7 --quiet $ASSETS_DIR/$1.png
-fi
-done
-
-exit 0

assets/assets-color/render-select-4k.sh

@@ -1,27 +0,0 @@
-#! /bin/bash
-
-INKSCAPE="/usr/bin/inkscape"
-OPTIPNG="/usr/bin/optipng"
-
-INDEX="select.txt"
-ASSETS_DIR="select-4k"
-SRC_FILE="select.svg"
-
-install -d $ASSETS_DIR
-
-for i in `cat $INDEX`
-do
-if [ -f $ASSETS_DIR/$i.png ]; then
-  echo $ASSETS_DIR/$i.png exists.
-else
-  echo
-  echo Rendering $ASSETS_DIR/$i.png
-  $INKSCAPE --export-id=$i \
-            --export-dpi=192 \
-            --export-id-only \
-            --export-filename=$ASSETS_DIR/$i.png $SRC_FILE >/dev/null
-  $OPTIPNG -o7 --quiet $ASSETS_DIR/$1.png
-fi
-done
-
-exit 0

assets/assets-color/select.svg

@@ -1,80 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Created with Inkscape (http://www.inkscape.org/) -->
-
-<svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
-   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
-   width="36"
-   height="36"
-   viewBox="0 0 9.5249997 9.5250002"
-   version="1.1"
-   id="svg8"
-   inkscape:version="0.92.4 (5da689c313, 2019-01-14)"
-   sodipodi:docname="select.svg">
-  <defs
-     id="defs2" />
-  <sodipodi:namedview
-     id="base"
-     pagecolor="#b7b7b7"
-     bordercolor="#666666"
-     borderopacity="1.0"
-     inkscape:pageopacity="0"
-     inkscape:pageshadow="2"
-     inkscape:zoom="7.919596"
-     inkscape:cx="16.187532"
-     inkscape:cy="24.609314"
-     inkscape:document-units="mm"
-     inkscape:current-layer="layer1"
-     showgrid="true"
-     units="px"
-     inkscape:window-width="1366"
-     inkscape:window-height="714"
-     inkscape:window-x="0"
-     inkscape:window-y="28"
-     inkscape:window-maximized="1">
-    <inkscape:grid
-       type="xygrid"
-       id="grid28" />
-  </sodipodi:namedview>
-  <metadata
-     id="metadata5">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title />
-      </cc:Work>
-    </rdf:RDF>
-  </metadata>
-  <g
-     inkscape:label="Layer 1"
-     inkscape:groupmode="layer"
-     id="layer1"
-     transform="translate(0,-287.47498)">
-    <rect
-       style="opacity:0.15;fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.52916658;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;paint-order:stroke fill markers"
-       id="select_c"
-       width="2.1166654"
-       height="9.5249996"
-       x="3.96875"
-       y="287.47498"
-       ry="0.016929913" />
-    <path
-       style="opacity:0.15;fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.52916658;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;paint-order:stroke fill markers"
-       d="m 3.9527305,287.47604 c -0.7253518,0.009 -1.3068969,0.59441 -1.3068969,1.32188 v 6.87917 c 0,0.72747 0.5815451,1.31324 1.3068969,1.32188 0.00858,-8.4e-4 0.01602,-0.007 0.01602,-0.016 v -9.49089 c 0,-0.009 -0.00744,-0.0152 -0.01602,-0.016 z"
-       id="select_w"
-       inkscape:connector-curvature="0" />
-    <path
-       style="opacity:0.15;fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.52916658;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;paint-order:stroke fill markers"
-       d="m 6.1014366,287.47604 c -0.00858,8.4e-4 -0.01602,0.007 -0.01602,0.016 v 9.49089 c 0,0.009 0.00744,0.0152 0.01602,0.016 0.7253517,-0.009 1.3068967,-0.59441 1.3068967,-1.32188 v -6.87917 c 0,-0.72747 -0.581545,-1.31324 -1.3068967,-1.32188 z"
-       id="select_e"
-       inkscape:connector-curvature="0" />
-  </g>
-</svg>

assets/assets-color/select.txt

@@ -1,3 +0,0 @@
-select_w
-select_c
-select_e

assets/assets-white/render-logos-1080p.sh

@@ -1,35 +0,0 @@
-#! /bin/bash
-
-INKSCAPE="/usr/bin/inkscape"
-OPTIPNG="/usr/bin/optipng"
-
-INDEX="logos.txt"
-ASSETS_DIR="icons-1080p"
-SRC_FILE="logos.svg"
-
-install -d $ASSETS_DIR
-
-for i in `cat $INDEX`
-do
-if [ -f $ASSETS_DIR/$i.png ]; then
-  echo $ASSETS_DIR/$i.png exists.
-else
-  echo
-  echo Rendering $ASSETS_DIR/$i.png
-  $INKSCAPE --export-id=$i \
-            --export-id-only \
-            --export-filename=$ASSETS_DIR/$i.png $SRC_FILE >/dev/null
-  $OPTIPNG -o7 --quiet $ASSETS_DIR/$1.png
-fi
-done
-
-cd $ASSETS_DIR
-cp -a archlinux.png arch.png
-cp -a gnu-linux.png linux.png
-cp -a gnu-linux.png unknown.png
-cp -a gnu-linux.png lfs.png
-cp -a manjaro.png Manjaro.i686.png
-cp -a manjaro.png Manjaro.x86_64.png
-cp -a driver.png memtest.png
-
-exit 0

assets/assets-white/render-logos-2k.sh

@@ -1,36 +0,0 @@
-#! /bin/bash
-
-INKSCAPE="/usr/bin/inkscape"
-OPTIPNG="/usr/bin/optipng"
-
-INDEX="logos.txt"
-ASSETS_DIR="icons-2k"
-SRC_FILE="logos.svg"
-
-install -d $ASSETS_DIR
-
-for i in `cat $INDEX`
-do
-if [ -f $ASSETS_DIR/$i.png ]; then
-  echo $ASSETS_DIR/$i.png exists.
-else
-  echo
-  echo Rendering $ASSETS_DIR/$i.png
-  $INKSCAPE --export-id=$i \
-            --export-dpi=144 \
-            --export-id-only \
-            --export-filename=$ASSETS_DIR/$i.png $SRC_FILE >/dev/null
-  $OPTIPNG -o7 --quiet $ASSETS_DIR/$1.png
-fi
-done
-
-cd $ASSETS_DIR
-cp -a archlinux.png arch.png
-cp -a gnu-linux.png linux.png
-cp -a gnu-linux.png unknown.png
-cp -a gnu-linux.png lfs.png
-cp -a manjaro.png Manjaro.i686.png
-cp -a manjaro.png Manjaro.x86_64.png
-cp -a driver.png memtest.png
-
-exit 0

assets/assets-white/render-logos-4k.sh

@@ -1,36 +0,0 @@
-#! /bin/bash
-
-INKSCAPE="/usr/bin/inkscape"
-OPTIPNG="/usr/bin/optipng"
-
-INDEX="logos.txt"
-ASSETS_DIR="icons-4k"
-SRC_FILE="logos.svg"
-
-install -d $ASSETS_DIR
-
-for i in `cat $INDEX`
-do
-if [ -f $ASSETS_DIR/$i.png ]; then
-  echo $ASSETS_DIR/$i.png exists.
-else
-  echo
-  echo Rendering $ASSETS_DIR/$i.png
-  $INKSCAPE --export-id=$i \
-            --export-dpi=192 \
-            --export-id-only \
-            --export-filename=$ASSETS_DIR/$i.png $SRC_FILE >/dev/null
-  $OPTIPNG -o7 --quiet $ASSETS_DIR/$1.png
-fi
-done
-
-cd $ASSETS_DIR
-cp -a archlinux.png arch.png
-cp -a gnu-linux.png linux.png
-cp -a gnu-linux.png unknown.png
-cp -a gnu-linux.png lfs.png
-cp -a manjaro.png Manjaro.i686.png
-cp -a manjaro.png Manjaro.x86_64.png
-cp -a driver.png memtest.png
-
-exit 0

assets/assets-white/render-select-1080p.sh

@@ -1,26 +0,0 @@
-#! /bin/bash
-
-INKSCAPE="/usr/bin/inkscape"
-OPTIPNG="/usr/bin/optipng"
-
-INDEX="select.txt"
-ASSETS_DIR="select-1080p"
-SRC_FILE="select.svg"
-
-install -d $ASSETS_DIR
-
-for i in `cat $INDEX`
-do
-if [ -f $ASSETS_DIR/$i.png ]; then
-  echo $ASSETS_DIR/$i.png exists.
-else
-  echo
-  echo Rendering $ASSETS_DIR/$i.png
-  $INKSCAPE --export-id=$i \
-            --export-id-only \
-            --export-filename=$ASSETS_DIR/$i.png $SRC_FILE >/dev/null
-  $OPTIPNG -o7 --quiet $ASSETS_DIR/$1.png
-fi
-done
-
-exit 0

assets/assets-white/render-select-2k.sh

@@ -1,27 +0,0 @@
-#! /bin/bash
-
-INKSCAPE="/usr/bin/inkscape"
-OPTIPNG="/usr/bin/optipng"
-
-INDEX="select.txt"
-ASSETS_DIR="select-2k"
-SRC_FILE="select.svg"
-
-install -d $ASSETS_DIR
-
-for i in `cat $INDEX`
-do
-if [ -f $ASSETS_DIR/$i.png ]; then
-  echo $ASSETS_DIR/$i.png exists.
-else
-  echo
-  echo Rendering $ASSETS_DIR/$i.png
-  $INKSCAPE --export-id=$i \
-            --export-dpi=144 \
-            --export-id-only \
-            --export-filename=$ASSETS_DIR/$i.png $SRC_FILE >/dev/null
-  $OPTIPNG -o7 --quiet $ASSETS_DIR/$1.png
-fi
-done
-
-exit 0

assets/assets-white/render-select-4k.sh

@@ -1,27 +0,0 @@
-#! /bin/bash
-
-INKSCAPE="/usr/bin/inkscape"
-OPTIPNG="/usr/bin/optipng"
-
-INDEX="select.txt"
-ASSETS_DIR="select-4k"
-SRC_FILE="select.svg"
-
-install -d $ASSETS_DIR
-
-for i in `cat $INDEX`
-do
-if [ -f $ASSETS_DIR/$i.png ]; then
-  echo $ASSETS_DIR/$i.png exists.
-else
-  echo
-  echo Rendering $ASSETS_DIR/$i.png
-  $INKSCAPE --export-id=$i \
-            --export-dpi=192 \
-            --export-id-only \
-            --export-filename=$ASSETS_DIR/$i.png $SRC_FILE >/dev/null
-  $OPTIPNG -o7 --quiet $ASSETS_DIR/$1.png
-fi
-done
-
-exit 0