1
1
mirror of https://github.com/rywng/dotfiles.git synced 2024-11-21 18:31:49 +08:00

docs(README): Update readme for dots

(It's been around 2 years)
This commit is contained in:
Ryan 2024-03-06 22:17:20 +08:00
parent 58a35a9541
commit fb9a01a940

View File

@ -2,15 +2,19 @@
Linux desktop with gruvbox colorscheme, following the KISS philosophy.
## TODO
- [ ] Use [zim](https://github.com/zimfw/zimfw)
- [ ] Update screenshots (It's using serenade instead of gruvbox)
# Screenshots
![code](https://github.com/rywng/dotfiles/assets/72336775/2101a2b3-240f-4c18-9bd4-630c1d4c9036)
![blank](https://github.com/rywng/dotfiles/assets/72336775/c8626d9b-2ea1-4576-946d-883fb5b3688f)
<details open>
<summary>Old Screenshots</summary>
<br>
These are screenshots I took 2 years ago when I was using [serenade](https://github.com/rywng/dotfiles/commit/85e37a124be69b2c9366c6745204457c91cb8871) :)
Kept them around because they look quite good
![terminal](https://user-images.githubusercontent.com/72336775/176679848-a66143cb-0df8-4fd0-a567-66693c33741e.png)
![blank](https://user-images.githubusercontent.com/72336775/176679629-c8da017a-2daf-4871-a34f-75bcd3738e28.png)
</details>
# Installing
@ -22,23 +26,25 @@ yadm clone https://github.com/JuanCldCmt/dotfiles
# Software
| Name | Description |
|------|-------------|
|hyprland|wayland WM with better nvidia support|
|waybar|Custom bar for sway|
|swayNC|Notification center|
|wofi|App launcher|
|kitty|Terminal emulator|
|zsh|Interactive Shell|
|mpv|Video player|
|zathura|PDF viewer|
| Name | Description |
| ------- | ----------------------------------- |
| fuzzel | App launcher & dmenu alternative |
| kitty | Terminal emulator |
| mpv | Video player |
| swayNC | Notification center |
| swayWM | Stupid simple and stable wayland WM |
| waybar | bar |
| zathura | PDF viewer |
| zsh | Interactive Shell |
# Depencencies
# Dependencies
|Name|Description|
|----|-----------|
|wlsunset|Shift blue color based on time|
|light|CLI for managing backlight|
|pipewire|Sound deamon|
|wireplumber|media session management (remember to replace it in sway's config if using non-gentoo)|
|playerctld|Control players|
| Name | Description |
| ----------- | --------------------------------------------------------------------------------------- |
| acpilight | CLI for managing backlight |
| easyeffects | EQ for IEMs and headphones |
| pipewire | Sound daemon |
| playerctld | Control players |
| wireplumber | media session management (remember to replace it in sway's config if using non-systemd) |
| wlsunset | Shift blue color based on time (Protects my eyes) |
| wob | show screen backlight and audio output volume level |