diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ce1fbe7 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# Various dotfiles for my [FreeBSD](https://freebsd.org/) - [River](https://codeberg.org/river/river) setup. +River is a dynamic tiling Wayland compositor with flexible runtime configuration. + + + +## Details + +Below is a list of some of the packages that I use for my current setup which consists of two screens. A monitor as the main screen and the laptop screen as a slave and Kanshi is used to set the monitor as the left most and apply focus to it using a riverctl focus-output command. Please note that my config isn't perfect so your mileage may vary.<br /> +The wallpaper featured in the screenshots can be found here: https://cdna.artstation.com/p/assets/images/images/015/554/914/large/artur-sadlos-to-sh300-ooh-as-05i.jpg + + +- **Operating System** --- [FreeBSD](https://freebsd.org/) +- **Boot Loader** --- [ZFS Boot Menu](https://github.com/zbm-dev/zfsbootmenu) +- **Resource Monitor** --- [Btop](https://github.com/aristocratos/btop) +- **Window Manager** --- [River](https://codeberg.org/river/river) +- **Status Bar** --- [Eww](https://github.com/elkowar/eww) + - **River Tag Info** --- [River-bedload](https://git.sr.ht/~novakane/river-bedload) +- **Screen Detection** --- [wlr-randr](https://sr.ht/~emersion/wlr-randr/) +- **Screen Hotplug** --- [Kanshi](https://sr.ht/~emersion/kanshi/) +- **Screen Locker** --- [Swaylock](https://github.com/swaywm/swaylock) +- **Screenshots** --- [Grim](https://sr.ht/~emersion/grim/) + --- [Slurp](https://github.com/emersion/slurp) +- **Idle Management Daemon** --- [Swayidle](https://github.com/swaywm/swayidle) +- **Shell** --- [Bash](https://www.gnu.org/software/bash/) using [Starship](https://starship.rs/) +- **Completion** --- [Bash Completion](https://github.com/scop/bash-completion) +- **Terminal** --- [Foot](https://codeberg.org/dnkl/foot) +- **Notification Daemon** --- [Mako](https://github.com/emersion/mako) +- **Notification Client** --- [FYI](https://codeberg.org/dnkl/fyi) +- **Application Launcher** --- [Fuzzel](https://codeberg.org/dnkl/fuzzel) +- **File Manager** --- [LF](https://github.com/gokcehan/lf) +- **Image Viewer** --- [Imv](https://git.sr.ht/~exec64/imv/) +- **Document Scanner** -- [Simple-scan](https://github.com/GNOME/simple-scan) +- **Editor** --- [Helix](https://github.com/helix-editor/helix) + - **Plugins** + - [simple-completion-language-server](https://github.com/estin/simple-completion-language-server) +- **Web Browser** --- [Qutebrowser](https://www.qutebrowser.org) +- **Multimedia Framework** + - **PipeWire** + - [pipeWire](https://pipewire.org/) + - [alsa-pipewire](https://pipewire.org/) + - [libjack-pipewire](https://pipewire.org/) + - [wireplumber](https://gitlab.freedesktop.org/pipewire/wireplumber/) + - [libpulseaudio](https://www.freedesktop.org/wiki/Software/PulseAudio/) +- **PDF Viewer** --- [Zathura](https://git.pwmt.org/pwmt/zathura) +- **IRC** --- [Weechat](https://weechat.org/) +- **RSS Feed Reader** --- [Newsboat](https://newsboat.org/) +- **Youtube Downloader** --- [Yt-dlp (youtube-dl fork)](https://github.com/yt-dlp/yt-dlp) +- **Video player** --- [mpv](https://github.com/mpv-player/mpv) +- **Email Client** + - [aerc](https://git.sr.ht/~rjarry/aerc) + - [isync](https://isync.sourceforge.io/) + - [msmtp](https://marlam.de/msmtp/) + - [dante](https://www.inet.no/dante/) + - [w3m](https://w3m.sourceforge.net/) + - [msmtpqueue](https://github.com/marlam/msmtp-mirror/tree/master/scripts/msmtpqueue) + +## Keybindings +### Window manager controls +| Keys | Action | +| ------------------------------------ | ------------------------- | +| <kbd>MOD + q</kbd> | Kill window | +| <kbd>MOD + ENTER</kbd> | Spawn terminal | +| <kbd>MOD + d</kbd> | Fuzzel menu | +| <kbd>CTRL + MOD + p</kbd> | Fuzzel power menu | + +## To set the wallpaper + +From within lf if you highlight a valid image file and enter "bg" it will set that image as the default wallpaper. |