From 5d0be6ed21b8a87638f0dec828136c1ee1fcdd51 Mon Sep 17 00:00:00 2001 From: Clay Gomera Date: Sat, 3 Aug 2024 02:13:37 -0400 Subject: [PATCH] Updated README.md --- README.md | 48 ++++++++++++++++--------- assets/{logo.png => logo-dark.png} | Bin assets/{logo.svg => logo-dark.svg} | 0 assets/logo-light.png | Bin 0 -> 1793 bytes assets/logo-light.svg | 56 +++++++++++++++++++++++++++++ 5 files changed, 88 insertions(+), 16 deletions(-) rename assets/{logo.png => logo-dark.png} (100%) rename assets/{logo.svg => logo-dark.svg} (100%) create mode 100644 assets/logo-light.png create mode 100644 assets/logo-light.svg diff --git a/README.md b/README.md index c59521f83..ac5e9618c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ -

- neodotfiles -

- -

My custom suckless based desktop focused on absolute productivity and workflow control.

+
+ + + + neodotfiles + +

My custom suckless based desktop focused on absolute productivity and workflow control.

+
![screenshot](./assets/screenshot.png) @@ -35,8 +38,9 @@ - *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). + * *herbe & tiramisu:* a minimal and fast notification daemon (tiramisu is the daemon, herbe is the notification window, I bundled them together). * *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. @@ -47,23 +51,20 @@ Other configuration files included in this project are available at the config f * `.bash_profile & .bashrc`: Bash configuration files, the profile is neccesary to start up dwm on tty login. * `.config/btop`: [btop](https://github.com/aristocratos/btop) is a system monitoring utility, cooler than htop. Accesible from dwm via a scratchpad. -* `.config/gtk-2.0 & .config/gtk-3.0`: GTK theeming files, I use the Cantarell font, the [Gruvbox-Dark-BL](https://github.com/Fausto-Korpsvart/Gruvbox-GTK-Theme) theme and the [Simp1e-Gruvbox-Dark](https://gitlab.com/cursors/simp1e) cursor theme. +* `.config/gtk-2.0` & `.config/gtk-3.0`: GTK theeming files, I use the Cantarell font, the [Gruvbox-Dark-BL](https://github.com/Fausto-Korpsvart/Gruvbox-GTK-Theme) theme and the [Simp1e-Gruvbox-Dark](https://gitlab.com/cursors/simp1e) cursor 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`: [musikcube](https://github.com/clangen/musikcube) is basically the best terminal music player. Also accesible from dwm via a scratchpad. Just like mpv, this is only for vim-like keybindings. -* `.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 X compositor that actually works, 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/qutebrowser`: Sometimes I like using a minimal browser, and qutebrowser is the best one. * `.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/vifm`: [vifm](https://vifm.info/) is the best terminal file manager with everything you will and may need, with vim-like keybindings and image previews (with ueberzug). * `.config/zathura`: [zathura](https://git.pwmt.org/pwmt/zathura) is my document viewer of choice, also with vim-like keybindings. ## Installation & How To Modify -Make sure to have these dependencies installed in your system: +Make sure to have these dependencies installed in your system, in this case package names are from Void Linux, you'll have to look for the package names in your distribution: * **Build dependencies** @@ -81,6 +82,8 @@ gd-devel pam-devel libnotify xinit +setxkbmap +brightnessctl make gcc vala @@ -89,7 +92,7 @@ vala * **Runtime dependencies** (required for dmenu scripts & dwm) ``` -fd +fd-find feh xdpyinfo xdotool @@ -97,16 +100,29 @@ ffmpeg maim slop udisks2 -bluez-utils +bluez j4-dmenu-desktop NetworkManager power-profiles-daemon -polkit-kde +polkit-gnome unclutter-xfixes gnome-keyring picom +ueberzug ``` +* **Other dependencies** (scratchpads) + +- `bitwarden`: launched with flatpak by default +- `btop` +- `pulsemixer` +- `newsboat` +- `arandr` +- `qalculate-gtk`: launched with flatpak by default +- `ytfzf`: [download here](https://github.com/pystardust/ytfzf) +- `ani-cli`: [download here](https://github.com/pystardust/ani-cli) +- `flix-cli`: [download here](https://github.com/d4r1us-drk/flix-cli) + 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. ```bash diff --git a/assets/logo.png b/assets/logo-dark.png similarity index 100% rename from assets/logo.png rename to assets/logo-dark.png diff --git a/assets/logo.svg b/assets/logo-dark.svg similarity index 100% rename from assets/logo.svg rename to assets/logo-dark.svg diff --git a/assets/logo-light.png b/assets/logo-light.png new file mode 100644 index 0000000000000000000000000000000000000000..771e332fb0e06d89fd824fe7cbc63de5c3353875 GIT binary patch literal 1793 zcmah~Yc$&l7XMp)q_rK5>d=fbQbrlAjkK(wRiZ_UQglMc`%!|Zgw&`;$&gUAOucP) zw8J!rDUyg(!WgkxDPvW%A+aVJtu~Rw5R!_`p8e9Z`(Z!a$GPX+bMLwL{(hHyIq1TH z{gC|t037i5Lxuu?!9%@&9JEKTts~Vkz1f%Lhr$BDCnNtBgE7pHiTdCXobOk-E0|;) zJ}x^6z~k{JQ!~-ngt)AvlbGz3CbLIz35qqq-AxABvYJTJrlQ`n^Hjuk&=Hya6M#leaKQNw0gK#w)~} zXw%W+HQ^7bnpUiwY7RS^LLlrk6%YTjO5zM}ZwXp<;$NFPJMhFIhLtO;p+w$&CzNfp zH$9gcuauEVf6L!V4ly;pB+%!RuyUiEQ6v(Vm8HIV&xBnTPzCk|!Ncjknpb}$DeU zz2;|Vyi|~gLP7+>s@cPn2W$fieEI}zhP*#)UG{ds#$Rx3ET{F*yqj7#uoFGOoZ)46 z%mj4OtP-fJn!i$Bq|vH*h~@b-5#dW{_1pbuSxe5?0~_8#+q=6kGdoGV)DTKpZw*Fr z&DX%_3};Si4)QS!l`M@AY44F5C1(9H{eewcZvlW8PTubt79K{6nHl2G$4jLjYA-xl z@e3~v{{{CY^f&T#`LjaOAIaCl!Y#P(gtfg-C+PPC#5^Vmq++${;kd7!0=*<+)-FXafUD8%F&Ia_u#2@Uu}$_ zLRks2{*GJUWjhcBZQIjJk#)i;DBc zziYQS5eGl*>gp<>iZVIQsO3RI8OgGd_BAN(CnmEY0(=M@(muV#hDqMec^krPaacRrY|S{!{NwUww0V?1|lOEG%}aYV8oD4i&=MIUsM!`RN|eql#~>46<1z)q>dub$jI>Y!R@K3qHR>u zHbOg<-XL4>cD2I?+s}p^Cz#q6ta=RML{u02_gGeO2rV1>oWBRr-2ny^bA;{=3mK!k*$`&zc-cziWv(AS1 zcU%iru5=u)Y%%(C5UQ4AUluPVGGWO-%*mpk_oPqB>vFd>>!q4)U2m_@JV9QOCxSwS zb8{>V97UYdQ7)Bwl!_3M*P{7MxVBgEP(QQwI2cS>j*iaQn7M0ER0b(ZF(N_>^xyzT$( zL3+Gp6eG0ub>JEqnr%zW8tW2{nRwSnTSg(59^#7T*2A5-7J26S-Cj}WjOTM;x1Upt poZ^fDKtUMJaQ%PW{vXQM?X?CaHA?K8`t_dy@b?WuQoUn~{sk7if8788 literal 0 HcmV?d00001 diff --git a/assets/logo-light.svg b/assets/logo-light.svg new file mode 100644 index 000000000..e8ef0771f --- /dev/null +++ b/assets/logo-light.svg @@ -0,0 +1,56 @@ + + + + + + + + NEODOTFILES + +