Updated README.md
This commit is contained in:
parent
34357e073d
commit
5d0be6ed21
5 changed files with 88 additions and 16 deletions
48
README.md
48
README.md
|
@ -1,8 +1,11 @@
|
||||||
<h1 align="center">
|
<div align="center">
|
||||||
<img src="assets/logo.png" alt="neodotfiles" width="415">
|
<picture>
|
||||||
</h1>
|
<source srcset="./assets/logo-dark.png" media="(prefers-color-scheme: dark)">
|
||||||
|
<source srcset="./assets/logo-light.png" media="(prefers-color-scheme: light)">
|
||||||
<h4 align="center">My custom suckless based desktop focused on absolute productivity and workflow control.</h4>
|
<img src="assets/logo-dark.png" alt="neodotfiles" width="415">
|
||||||
|
</picture>
|
||||||
|
<h4>My custom suckless based desktop focused on absolute productivity and workflow control.</h4>
|
||||||
|
</div>
|
||||||
|
|
||||||
![screenshot](./assets/screenshot.png)
|
![screenshot](./assets/screenshot.png)
|
||||||
|
|
||||||
|
@ -35,8 +38,9 @@
|
||||||
- *Tag 9:* Gaming
|
- *Tag 9:* Gaming
|
||||||
|
|
||||||
### Other suckless utilities included
|
### 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.
|
* *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).
|
* *st:* the fastest terminal emulator ever, [siduck's build](https://github.com/siduck/st).
|
||||||
* *slock:* simple and efficient lock screen with fingerprint reader support.
|
* *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.
|
* *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.
|
* `.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/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/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/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/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/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/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/qutebrowser`: Sometimes I like using a minimal browser, and qutebrowser is the best one.
|
||||||
* `.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/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.
|
* `.config/zathura`: [zathura](https://git.pwmt.org/pwmt/zathura) is my document viewer of choice, also with vim-like keybindings.
|
||||||
|
|
||||||
## Installation & How To Modify
|
## 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**
|
* **Build dependencies**
|
||||||
|
|
||||||
|
@ -81,6 +82,8 @@ gd-devel
|
||||||
pam-devel
|
pam-devel
|
||||||
libnotify
|
libnotify
|
||||||
xinit
|
xinit
|
||||||
|
setxkbmap
|
||||||
|
brightnessctl
|
||||||
make
|
make
|
||||||
gcc
|
gcc
|
||||||
vala
|
vala
|
||||||
|
@ -89,7 +92,7 @@ vala
|
||||||
* **Runtime dependencies** (required for dmenu scripts & dwm)
|
* **Runtime dependencies** (required for dmenu scripts & dwm)
|
||||||
|
|
||||||
```
|
```
|
||||||
fd
|
fd-find
|
||||||
feh
|
feh
|
||||||
xdpyinfo
|
xdpyinfo
|
||||||
xdotool
|
xdotool
|
||||||
|
@ -97,16 +100,29 @@ ffmpeg
|
||||||
maim
|
maim
|
||||||
slop
|
slop
|
||||||
udisks2
|
udisks2
|
||||||
bluez-utils
|
bluez
|
||||||
j4-dmenu-desktop
|
j4-dmenu-desktop
|
||||||
NetworkManager
|
NetworkManager
|
||||||
power-profiles-daemon
|
power-profiles-daemon
|
||||||
polkit-kde
|
polkit-gnome
|
||||||
unclutter-xfixes
|
unclutter-xfixes
|
||||||
gnome-keyring
|
gnome-keyring
|
||||||
picom
|
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.
|
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
|
```bash
|
||||||
|
|
Before Width: | Height: | Size: 2 KiB After Width: | Height: | Size: 2 KiB |
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
BIN
assets/logo-light.png
Normal file
BIN
assets/logo-light.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.8 KiB |
56
assets/logo-light.svg
Normal file
56
assets/logo-light.svg
Normal file
|
@ -0,0 +1,56 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
||||||
|
|
||||||
|
<svg
|
||||||
|
width="415"
|
||||||
|
height="40"
|
||||||
|
viewBox="0 0 415 40"
|
||||||
|
version="1.1"
|
||||||
|
id="svg1"
|
||||||
|
inkscape:export-filename="logo.png"
|
||||||
|
inkscape:export-xdpi="96"
|
||||||
|
inkscape:export-ydpi="96"
|
||||||
|
inkscape:version="1.3.2 (091e20ef0f, 2023-11-25)"
|
||||||
|
sodipodi:docname="logo-light.svg"
|
||||||
|
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||||
|
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:svg="http://www.w3.org/2000/svg">
|
||||||
|
<sodipodi:namedview
|
||||||
|
id="namedview1"
|
||||||
|
pagecolor="#ffffff"
|
||||||
|
bordercolor="#000000"
|
||||||
|
borderopacity="0.25"
|
||||||
|
inkscape:showpageshadow="2"
|
||||||
|
inkscape:pageopacity="0.0"
|
||||||
|
inkscape:pagecheckerboard="0"
|
||||||
|
inkscape:deskcolor="#d1d1d1"
|
||||||
|
inkscape:document-units="px"
|
||||||
|
inkscape:zoom="2.728764"
|
||||||
|
inkscape:cx="202.65585"
|
||||||
|
inkscape:cy="65.963931"
|
||||||
|
inkscape:window-width="1918"
|
||||||
|
inkscape:window-height="1057"
|
||||||
|
inkscape:window-x="0"
|
||||||
|
inkscape:window-y="21"
|
||||||
|
inkscape:window-maximized="1"
|
||||||
|
inkscape:current-layer="layer1" />
|
||||||
|
<defs
|
||||||
|
id="defs1" />
|
||||||
|
<g
|
||||||
|
inkscape:label="Layer 1"
|
||||||
|
inkscape:groupmode="layer"
|
||||||
|
id="layer1">
|
||||||
|
<text
|
||||||
|
xml:space="preserve"
|
||||||
|
style="font-size:33.0501px;font-family:'sucklessfont_v1.1';-inkscape-font-specification:'sucklessfont_v1.1, Normal';fill:#1a1a1a;stroke:#000000;stroke-width:0.1;stroke-dasharray:none;stroke-opacity:1"
|
||||||
|
x="2.1633663"
|
||||||
|
y="31.79669"
|
||||||
|
id="text1"><tspan
|
||||||
|
sodipodi:role="line"
|
||||||
|
id="tspan1"
|
||||||
|
x="2.1633663"
|
||||||
|
y="31.79669"
|
||||||
|
style="stroke:#000000;stroke-width:0.1;stroke-dasharray:none;stroke-opacity:1;fill:#1a1a1a">NEODOTFILES</tspan></text>
|
||||||
|
</g>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 1.8 KiB |
Loading…
Reference in a new issue