From 9d67a50fb8fa84c44ba880369ba84bc84330192d Mon Sep 17 00:00:00 2001 From: adi1090x Date: Fri, 19 Aug 2022 19:54:27 +0530 Subject: [PATCH] Updated Readme file --- README.md | 136 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 131 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7aeea03..929cab0 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,8 @@

A huge collection of Rofi based custom Applets, Launchers & Powermenus.

-**`Launchers`** +
+Launchers |Type 1|Type 2|Type 3|Type 4| |--|--|--|--| @@ -29,9 +30,23 @@ |--|--|--| |![img](previews/launchers/type-5.gif)|![img](previews/launchers/type-6.gif)|![img](previews/launchers/type-7.gif)| -**`Applets`** : _Coming soon_ +
-**`Powermenus`** +
+Applets + +|Type 1|Type 2|Type 3| +|--|--|--| +|![img](previews/applets/type-1.gif)|![img](previews/applets/type-2.gif)|![img](previews/applets/type-3.gif)| + +|Type 4|Type 5| +|--|--| +|![img](previews/applets/type-4.gif)|![img](previews/applets/type-5.gif)| + +
+ +
+Powermenus |Type 1|Type 2|Type 3| |--|--|--| @@ -41,6 +56,8 @@ |--|--|--| |![img](previews/powermenu/type-4.gif)|![img](previews/powermenu/type-5.gif)|![img](previews/powermenu/type-6.gif)| +
+ ## What is Rofi? [Rofi](https://github.com/davatorium/rofi) is A window switcher, Application launcher and dmenu replacement. Rofi started as a clone of simpleswitcher and It has been extended with extra features, like an application launcher and ssh-launcher, and can act as a drop-in dmenu replacement, making it a very versatile tool. Rofi, like dmenu, will provide the user with a textual list of options where one or more can be selected. This can either be running an application, selecting a window, or options provided by an external script. @@ -92,7 +109,7 @@ $ ./setup.sh

- Guney Can Gokoglu +

--- @@ -234,7 +251,116 @@ theme='style-1' ## Applets -_Coming Soon_ + +|Applets|Description|Required Applications| +|:-|:-|:-| +|**`Apps As Root`**|Open Applications as root|`pkexec` : `alacritty`, `thunar`, `geany`, `ranger`, `vim`| +|**`Apps`**|Favorite or most used Applications|`alacritty`, `thunar`, `geany`, `firefox`, `ncmpcpp`, `xfce4-settings-manager`| +|**`Battery`**|Display battery percentage & charging status with dynamic icons|`pkexec`, `acpi`, `powertop` `xfce4-power-manager-settings`| +|**`Brightness`**|Display and adjust screen brightness|`light`, `xfce4-power-manager-settings`| +|**`MPD`**|Control the song play through **`mpd`**|`mpd`, `mpc`| +|**`Powermenu`**|A classic power menu, with Uptime|`systemd`, `betterlockscreen`| +|**`Quicklinks`**|Bookmarks for most used websites|`firefox` or `chromium` or any other browser| +|**`Screenshot`**|Take screenshots using **`maim`**|`maim`, `xrandr`, `dunst`, `xclip`| +|**`Volume`**|Display and control volume with dynamic icons and mute status|`amixer` and `pavucontrol`| + +> To use your programs with these applets, Edit the scripts in `~/.config/rofi/applets/bin` directory. + +**`Change Theme` :** Edit `~/.config/rofi/applets/shared/theme.bash` script and edit the following line to use the type and style you like. +```ini +type="$HOME/.config/rofi/applets/type-1" +style='style-1.rasi' +``` + +**`Change Colors` :** Edit `~/.config/rofi/applets/shared/colors.rasi` file and edit the following line to use the color-scheme you like. +```css +@import "~/.config/rofi/colors/onedark.rasi" +``` + +> Colors in `type-4` and `type-5` are hard-coded (based on image colors) and can be changed by editing the respective **`style-X.rasi`** file. + +#### Previews + +
+Apps as root + +|Type 1|Type 2|Type 3|Type 4|Type 5| +|--|--|--|--|--| +|![img](previews/applets/1/1.png)|![img](previews/applets/1/2.png)|![img](previews/applets/1/3.png)|![img](previews/applets/1/4.png)|![img](previews/applets/1/5.png)| + +
+ +
+Apps + +|Type 1|Type 2|Type 3|Type 4|Type 5| +|--|--|--|--|--| +|![img](previews/applets/2/1.png)|![img](previews/applets/2/2.png)|![img](previews/applets/2/3.png)|![img](previews/applets/2/4.png)|![img](previews/applets/2/5.png)| + +
+ +
+Battery + +|Type 1|Type 2|Type 3|Type 4|Type 5| +|--|--|--|--|--| +|![img](previews/applets/3/1.png)|![img](previews/applets/3/2.png)|![img](previews/applets/3/3.png)|![img](previews/applets/3/4.png)|![img](previews/applets/3/5.png)| + +
+ +
+Brightness + +|Type 1|Type 2|Type 3|Type 4|Type 5| +|--|--|--|--|--| +|![img](previews/applets/4/1.png)|![img](previews/applets/4/2.png)|![img](previews/applets/4/3.png)|![img](previews/applets/4/4.png)|![img](previews/applets/4/5.png)| + +
+ +
+MPD + +|Type 1|Type 2|Type 3|Type 4|Type 5| +|--|--|--|--|--| +|![img](previews/applets/5/1.png)|![img](previews/applets/5/2.png)|![img](previews/applets/5/3.png)|![img](previews/applets/5/4.png)|![img](previews/applets/5/5.png)| + +
+ +
+Powermenu + +|Type 1|Type 2|Type 3|Type 4|Type 5| +|--|--|--|--|--| +|![img](previews/applets/6/1.png)|![img](previews/applets/6/2.png)|![img](previews/applets/6/3.png)|![img](previews/applets/6/4.png)|![img](previews/applets/6/5.png)| + +
+ +
+Quicklinks + +|Type 1|Type 2|Type 3|Type 4|Type 5| +|--|--|--|--|--| +|![img](previews/applets/7/1.png)|![img](previews/applets/7/2.png)|![img](previews/applets/7/3.png)|![img](previews/applets/7/4.png)|![img](previews/applets/7/5.png)| + +
+ +
+Screenshot + +|Type 1|Type 2|Type 3|Type 4|Type 5| +|--|--|--|--|--| +|![img](previews/applets/8/1.png)|![img](previews/applets/8/2.png)|![img](previews/applets/8/3.png)|![img](previews/applets/8/4.png)|![img](previews/applets/8/5.png)| + +
+ +
+Volume + +|Type 1|Type 2|Type 3|Type 4|Type 5| +|--|--|--|--|--| +|![img](previews/applets/9/1.png)|![img](previews/applets/9/2.png)|![img](previews/applets/9/3.png)|![img](previews/applets/9/4.png)|![img](previews/applets/9/5.png)| + +
## Powermenus