diff --git a/README.md b/README.md index 29da1da..31a9579 100644 --- a/README.md +++ b/README.md @@ -1 +1,166 @@ -# dotfile \ No newline at end of file +
+

+

~Bspwm dotfiles ~

+ + + + +
+ + +## Info + +|Distro|[Arch](https://archlinux.org/)| +|:---:|:---:| +|WM|[BSPWM](https://github.com/baskerville/bspwm)| +|Bar|[Polybar](https://github.com/polybar/polybar)| +|Menu|[Rofi](https://github.com/davatorium/rofi)| +|Compositor|[Ibhagwan-Picom](https://github.com/ibhagwan/picom-ibhagwan-git)| +|Terminal|[Alacritty](https://github.com/alacritty/alacritty)-[Kitty](https://sw.kovidgoyal.net/kitty/)| +|Widgets|[ElKowars wacky widgets ](https://github.com/elkowar/eww)| +|Music/Player|[mpd](https://archlinux.org/packages/extra/x86_64/mpd/)-[ncmpcpp](https://archlinux.org/packages/community/x86_64/ncmpcpp/)| +|File Manager|[Thunar](https://archlinux.org/packages/extra/x86_64/thunar/)| + + + + + + + + +
+ :warning: WARNING :warning: +
+ + + + THIS DOTFILES ARE CONFIGURED AT 1920x1080 WITH 96 DPI! 1 MONITOR + SOME STUFF MIGHT BREAK ON LOWER OR HIGHER + RESOLUTIONS BUT WILL STILL WORK! + +
+ +## Very useful keybindigs to know... + +- alt + F1 For HotKeys +- alt + @space Apps Menu. +- super + h Hides bar +- Print Takes screenshot. +- super + Return Open a terminal. +- super + shift + Return Open a floating terminal. +- super + c Kill a window/process. +- shift + alt + w Changes randomly wallpaper. +- ctrl + shift + r Restart bspwm. +[Other Keybinds](https://github.com/S4NKALP/bspwm/wiki/Keyboard-Shortcuts.md) + + + ## 📦 Setup (Isn't Full Installation. Be careful about it.) + > This is step-by-step how to install these bspwm dotfiles. Just [R.T.F.M](https://en.wikipedia.org/wiki/RTFM). + +### 💾 Installation: +The installer only works for **ARCH** Linux, and based distros. + +Open a terminal in HOME +- **Clone the repo** +```sh +git clone https://github.com/S4NKALP/bspwm.git +cd bspwm + +``` +- **Install needed dependencies** +```sh +./install (if it show error give permission by chmod +x install + +``` +- **After installing copy all files to respective location** +- **If config didn't work then just give executive permission to all** +- **Copy fonts file to ~/.local/share/** + +
+ +> Once finished copying the files, you might want to finalize the changes to your system. + +```sh + # Rebuilds the font cache + $ fc-cache -fv +``` + +## Miscellaneous. + +- **Elkowar's Wacky Widgets** + + > If you're **NOT** using a monitor with a 1280x1080 resolution, you might want to change the `x` and `y` values of the widgets on the config. + +- **Theme Suggested** + + > Nordic Master [here](https://github.com/EliverLara/Nordic) & [another](https://github.com/Adapta-Projects/Papirus-Nord) + +- **Icon Theme Suggested** + > Nordzy Icon [this](https://github.com/alvatip/Nordzy-icon.git) + +- **Make Yourself window rule in bspwm** + +
+ +> Lastly, log out from your current desktop session and log in into bspwm. + +
+ +## Some tips +* If u dont want to use the random wallpapers comment line 150 from /home/YourUser/.config/bspwm/bspwmrc file. + + +## Troubleshooting +* **Weather module is showing wrong values** + +You need to edit ~/.config/eww/scripts/weather_info & in slidebar/scripts/Weather change the name of your city, you can get it from [openweathermap](https://openweathermap.org/) + +## Acknowledgements. + +- **Thanks to** + + - [rxyhn](https://github.com/rxyhn) + - [gh0szkt](https://github.com/gh0stzk) + - I forgot from where I took other code +
+ + +
+Screenshots + +**`Desktop`** + + + +**`Polybar`** + + + +**`Old Polybar`** + + + +**`Info-Panel`** + + + +**`Side-Bar`** + + + +**`MusicPlayer`** + + + + +**`FireFox`** + + + + +**`Old`** + + +
+ +