From ed2088cbd5e8cd6c523319494e42c6c24819235f Mon Sep 17 00:00:00 2001 From: Clay Gomera Date: Thu, 28 Mar 2024 19:20:58 -0400 Subject: [PATCH] Updated README.md --- README.md | 36 +++++++++++++++---- .../Gruvbox-Dark-Brown.kvconfig | 0 .../Gruvbox-Dark-Brown/Gruvbox-Dark-Brown.svg | 0 .../Kvantum/kvantum.kvconfig | 0 config/{config => .config}/X11/xinitrc | 0 config/{config => .config}/btop/btop.conf | 0 .../gtk-2.0/gtkfilechooser.ini | 0 config/{config => .config}/gtk-2.0/gtkrc-2.0 | 0 config/{config => .config}/gtk-3.0/bookmarks | 0 .../{config => .config}/gtk-3.0/settings.ini | 0 config/{config => .config}/lvim/config.lua | 0 config/{config => .config}/mimeapps.list | 0 config/{config => .config}/mpv/input.conf | 0 .../musikcube/hotkeys.json | 0 .../{config => .config}/neofetch/config.conf | 0 config/{config => .config}/newsboat/config | 0 config/{config => .config}/newsboat/urls | 0 config/{config => .config}/picom/picom.conf | 0 .../pipewire/pipewire-pulse.conf | 0 .../pipewire/pipewire.conf | 0 config/{config => .config}/tut/config.toml | 0 config/{config => .config}/yazi/keymap.toml | 0 config/{config => .config}/yazi/theme.toml | 0 config/{config => .config}/yazi/yazi.toml | 0 config/{config => .config}/zathura/zathurarc | 0 25 files changed, 30 insertions(+), 6 deletions(-) rename config/{config => .config}/Kvantum/Gruvbox-Dark-Brown/Gruvbox-Dark-Brown.kvconfig (100%) rename config/{config => .config}/Kvantum/Gruvbox-Dark-Brown/Gruvbox-Dark-Brown.svg (100%) rename config/{config => .config}/Kvantum/kvantum.kvconfig (100%) rename config/{config => .config}/X11/xinitrc (100%) rename config/{config => .config}/btop/btop.conf (100%) rename config/{config => .config}/gtk-2.0/gtkfilechooser.ini (100%) rename config/{config => .config}/gtk-2.0/gtkrc-2.0 (100%) rename config/{config => .config}/gtk-3.0/bookmarks (100%) rename config/{config => .config}/gtk-3.0/settings.ini (100%) rename config/{config => .config}/lvim/config.lua (100%) rename config/{config => .config}/mimeapps.list (100%) rename config/{config => .config}/mpv/input.conf (100%) rename config/{config => .config}/musikcube/hotkeys.json (100%) rename config/{config => .config}/neofetch/config.conf (100%) rename config/{config => .config}/newsboat/config (100%) rename config/{config => .config}/newsboat/urls (100%) rename config/{config => .config}/picom/picom.conf (100%) rename config/{config => .config}/pipewire/pipewire-pulse.conf (100%) rename config/{config => .config}/pipewire/pipewire.conf (100%) rename config/{config => .config}/tut/config.toml (100%) rename config/{config => .config}/yazi/keymap.toml (100%) rename config/{config => .config}/yazi/theme.toml (100%) rename config/{config => .config}/yazi/yazi.toml (100%) rename config/{config => .config}/zathura/zathurarc (100%) diff --git a/README.md b/README.md index b1d15a10f..f07569350 100644 --- a/README.md +++ b/README.md @@ -35,11 +35,31 @@ - *Tag 9:* Gaming ### Other suckless utilities included - - *dmenu:* the best run launcher. This build includes some very useful scripts for things like wifi, bluetooth and wallpaper configuration, drive mounting, etc. - - *herbe & tiramisu:* a minimal and fast notification daemon (tiramisu is the daemon, herbe is the notification window). - - *st:* the fastest terminal emulator ever, [siduck's build](https://github.com/siduck/st). - - *slock:* simple and efficient lock screen with fingerprint reader support. - - *dwbmlocks:* what enables you to customize dwm's status area in the bar. This build includes some cool & customizable status scripts. + * *dmenu:* the best run launcher. This build includes some very useful scripts for things like wifi, bluetooth and wallpaper configuration, drive mounting, etc. + * *herbe & tiramisu:* a minimal and fast notification daemon (tiramisu is the daemon, herbe is the notification window). + * *st:* the fastest terminal emulator ever, [siduck's build](https://github.com/siduck/st). + * *slock:* simple and efficient lock screen with fingerprint reader support. + * *dwbmlocks:* what enables you to customize dwm's status area in the bar. This build includes some cool & customizable status scripts. + +### Config files + +Other configuration files included in this project are available at the config folder. These are: + +* `.bash_profile & .bashrc`: Bash configuration files, the profile is neccesary to start up dwm on tty login. +* `.config/btop`: btop system monitoring utility, accesible from dwm via a scratchpad, more info [here](https://github.com/aristocratos/btop). +* `.config/gtk-2.0 & .config/gtk-3.0`: GTK theeming files, I use the Cantarell font and the [Gruvbox-Dark-BL](https://github.com/Fausto-Korpsvart/Gruvbox-GTK-Theme) theme. +* `.config/Kvantum`: Qt theeming via Kvantum, Gruvbox theme is included here too. +* `.config/lvim`: [Lunarvim](https://www.lunarvim.org/) configuration files, this is a neovim distribution and my text editor of choice. +* `.config/mpv`: Mpv config files, mainly just for vim-like keybindings. +* `.config/musikcube`: The best terminal music player. Also accesible from dwm via a scratchpad. Just like mpv, this is only for vim-like keybindings. You can learn more about musikcube [here](https://github.com/clangen/musikcube). +* `.config/neofetch`: Make neofetch look cooler. +* `.config/newsboat`: [Newsboat](https://github.com/newsboat/newsboat) is an awesome RSS/Atom feeds reader for the terminal. Also accesible from dwm via a scratchpad. The config file is for vim-like keybindings and also my collection of RSS & YouTube subscriptions feeds (you can open any video in mpv hitting first comma and then v). +* `.config/picom`: The only working X compositor that exists, responsible of transparency and some animations. +* `.config/pipewire`: Just to make pipewire behave a little better with Pro audio equipment (support for multiple sample rates). +* `.config/tut`: [tut](https://github.com/RasmusLindroth/tut) is an amazing Mastodon client for the terminal. Also accesible from dwm via a scratchpad. +* `.config/X11`: This is where I put the xinitrc file, responsible of starting up dwm properly. +* `.config/yazi`: [yazi](https://github.com/sxyazi/yazi) is the best terminal file manager with everything you will and may need, with vim-like keybindings and image previews. +* `.config/zathura`: [zathura](https://git.pwmt.org/pwmt/zathura) is my document viewer of choice, also with vim-like keybindings. ## Installation & How To Modify @@ -66,7 +86,7 @@ gcc vala ``` -* **Runtime dependencies** (required for dmenu scripts) +* **Runtime dependencies** (required for dmenu scripts & dwm) ``` fd @@ -81,6 +101,10 @@ bluez-utils j4-dmenu-desktop NetworkManager power-profiles-daemon +polkit-kde +unclutter-xfixes +gnome-keyring +picom ``` After installing them with your package manager of choice, you can do the following to get the source code and start to modify it to your liking. diff --git a/config/config/Kvantum/Gruvbox-Dark-Brown/Gruvbox-Dark-Brown.kvconfig b/config/.config/Kvantum/Gruvbox-Dark-Brown/Gruvbox-Dark-Brown.kvconfig similarity index 100% rename from config/config/Kvantum/Gruvbox-Dark-Brown/Gruvbox-Dark-Brown.kvconfig rename to config/.config/Kvantum/Gruvbox-Dark-Brown/Gruvbox-Dark-Brown.kvconfig diff --git a/config/config/Kvantum/Gruvbox-Dark-Brown/Gruvbox-Dark-Brown.svg b/config/.config/Kvantum/Gruvbox-Dark-Brown/Gruvbox-Dark-Brown.svg similarity index 100% rename from config/config/Kvantum/Gruvbox-Dark-Brown/Gruvbox-Dark-Brown.svg rename to config/.config/Kvantum/Gruvbox-Dark-Brown/Gruvbox-Dark-Brown.svg diff --git a/config/config/Kvantum/kvantum.kvconfig b/config/.config/Kvantum/kvantum.kvconfig similarity index 100% rename from config/config/Kvantum/kvantum.kvconfig rename to config/.config/Kvantum/kvantum.kvconfig diff --git a/config/config/X11/xinitrc b/config/.config/X11/xinitrc similarity index 100% rename from config/config/X11/xinitrc rename to config/.config/X11/xinitrc diff --git a/config/config/btop/btop.conf b/config/.config/btop/btop.conf similarity index 100% rename from config/config/btop/btop.conf rename to config/.config/btop/btop.conf diff --git a/config/config/gtk-2.0/gtkfilechooser.ini b/config/.config/gtk-2.0/gtkfilechooser.ini similarity index 100% rename from config/config/gtk-2.0/gtkfilechooser.ini rename to config/.config/gtk-2.0/gtkfilechooser.ini diff --git a/config/config/gtk-2.0/gtkrc-2.0 b/config/.config/gtk-2.0/gtkrc-2.0 similarity index 100% rename from config/config/gtk-2.0/gtkrc-2.0 rename to config/.config/gtk-2.0/gtkrc-2.0 diff --git a/config/config/gtk-3.0/bookmarks b/config/.config/gtk-3.0/bookmarks similarity index 100% rename from config/config/gtk-3.0/bookmarks rename to config/.config/gtk-3.0/bookmarks diff --git a/config/config/gtk-3.0/settings.ini b/config/.config/gtk-3.0/settings.ini similarity index 100% rename from config/config/gtk-3.0/settings.ini rename to config/.config/gtk-3.0/settings.ini diff --git a/config/config/lvim/config.lua b/config/.config/lvim/config.lua similarity index 100% rename from config/config/lvim/config.lua rename to config/.config/lvim/config.lua diff --git a/config/config/mimeapps.list b/config/.config/mimeapps.list similarity index 100% rename from config/config/mimeapps.list rename to config/.config/mimeapps.list diff --git a/config/config/mpv/input.conf b/config/.config/mpv/input.conf similarity index 100% rename from config/config/mpv/input.conf rename to config/.config/mpv/input.conf diff --git a/config/config/musikcube/hotkeys.json b/config/.config/musikcube/hotkeys.json similarity index 100% rename from config/config/musikcube/hotkeys.json rename to config/.config/musikcube/hotkeys.json diff --git a/config/config/neofetch/config.conf b/config/.config/neofetch/config.conf similarity index 100% rename from config/config/neofetch/config.conf rename to config/.config/neofetch/config.conf diff --git a/config/config/newsboat/config b/config/.config/newsboat/config similarity index 100% rename from config/config/newsboat/config rename to config/.config/newsboat/config diff --git a/config/config/newsboat/urls b/config/.config/newsboat/urls similarity index 100% rename from config/config/newsboat/urls rename to config/.config/newsboat/urls diff --git a/config/config/picom/picom.conf b/config/.config/picom/picom.conf similarity index 100% rename from config/config/picom/picom.conf rename to config/.config/picom/picom.conf diff --git a/config/config/pipewire/pipewire-pulse.conf b/config/.config/pipewire/pipewire-pulse.conf similarity index 100% rename from config/config/pipewire/pipewire-pulse.conf rename to config/.config/pipewire/pipewire-pulse.conf diff --git a/config/config/pipewire/pipewire.conf b/config/.config/pipewire/pipewire.conf similarity index 100% rename from config/config/pipewire/pipewire.conf rename to config/.config/pipewire/pipewire.conf diff --git a/config/config/tut/config.toml b/config/.config/tut/config.toml similarity index 100% rename from config/config/tut/config.toml rename to config/.config/tut/config.toml diff --git a/config/config/yazi/keymap.toml b/config/.config/yazi/keymap.toml similarity index 100% rename from config/config/yazi/keymap.toml rename to config/.config/yazi/keymap.toml diff --git a/config/config/yazi/theme.toml b/config/.config/yazi/theme.toml similarity index 100% rename from config/config/yazi/theme.toml rename to config/.config/yazi/theme.toml diff --git a/config/config/yazi/yazi.toml b/config/.config/yazi/yazi.toml similarity index 100% rename from config/config/yazi/yazi.toml rename to config/.config/yazi/yazi.toml diff --git a/config/config/zathura/zathurarc b/config/.config/zathura/zathurarc similarity index 100% rename from config/config/zathura/zathurarc rename to config/.config/zathura/zathurarc