add readme

This commit is contained in:
shibao 2021-11-20 18:49:57 -05:00
parent e77854b6b5
commit 9e20bf4e86
2 changed files with 40 additions and 0 deletions

BIN
preview.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1016 KiB

40
readme.md Normal file
View File

@ -0,0 +1,40 @@
### dotfiles
![preview](preview.png)
these are my dotfiles, custom desktop entries, and scripts for my personal machine
to use these verbatim, clone the repo and merge it onto root with rsync, like below.
please note that these are provided without guarantee or warranty of any kind.
please back up all your files before using these!
```
git clone https://gitea.bubbletea.dev/shibao/dotfiles.git
rsync -a dotfiles/* /
```
thank you!
### requirements
this isn't an exhaustive list.
please let me know if i've forgotten one!
- sway (de)
- waybar (topbar)
- swayidle (idle daemon)
- swaylock (lockscreen)
- alacritty (terminal)
- rofi (launcher)
- moki (notification daemon)
- kanshi (screen config manager)
- lxpolkit (auth helper)
- nm-applet (network gui manager)
- playerctl (music controller)
- materia-dark (gtk theme)
- papirus-dark (icon theme)
- fctix (intl. keyboard input)
- grim (screenshots on wayland)
- neovim (editor)
- direnv (per-directory environment variables)
- asdf (language agnostic dependency management)