Hyprland-dotfiles/README.md

85 lines
2.9 KiB
Markdown
Raw Normal View History

2023-08-31 09:01:03 -04:00
# ML4W dotfiles
2023-01-22 12:27:01 -05:00
2023-10-17 11:31:46 -04:00
This is my configuration of Hyprland (Wayland) and Qtile (Xorg).
This package includes installation scripts to install and setup the required components.
The dotfiles are tested with Arch Linux, Manjaro Linux, EndeavourOS and Arco Linux.
2023-08-31 09:01:03 -04:00
## Common Packages
2023-04-06 08:49:57 -04:00
2023-04-13 15:47:30 -04:00
- Terminal: alacritty
- Editor: nvim
- Prompt: starship
- Icons: Font Awesome
- Menus: Rofi
- Colorscheme: pywal (dynamic)
2023-10-17 11:31:46 -04:00
- Browsers: chromium (brave optional)
- Filemanager: Thunar
- Cursor: Bibata Modern Ice
- Icons: Papirus-Icon-Theme
2023-04-13 15:47:30 -04:00
- Virtual Machine: qemu (Windows 11 with looking glass and xrdp)
2023-04-06 08:49:57 -04:00
2023-08-31 09:01:03 -04:00
## Hyprland
- Status Bar: waybar
2023-10-03 05:37:41 -04:00
- Screenshots: grim & slurp
- Clipboard Manager: cliphist
- Logout: wlogout
- Screenlock: swaylock-effects
2023-08-31 09:01:03 -04:00
## Qtile
- Compositor: picom
- Status Bar: polybar
- Screenshots: scrot
## Templating
2023-04-06 08:49:57 -04:00
2023-10-03 05:37:41 -04:00
Included is a pywal configuration that changes the color scheme based on a randomly selected wallpaper. With the key binding SuperKey + Shift + w you can change the wallpaper. SuperKey + Ctrl + w opens rofi with a list of installed wallpapers for your individual selection. See also the .bashrc and the key bindings on Hyprland and Qtile for more alias definitions.
2023-02-18 11:02:06 -05:00
2023-10-17 11:31:46 -04:00
In addition, you can switch the Waybar Template with SUPER + CTRL + T or by pressing the "..." icon in Waybar. The templates are available in ~/dotfiles/waybar/themes. You can add your own personal themes into this folder. The script will read in the folder structure.
2023-04-25 09:39:48 -04:00
## Screenshots & Video
2023-01-22 12:27:01 -05:00
2023-10-04 08:38:42 -04:00
<a href="https://youtu.be/ELEQh0z3lm8" target="_blank"><img src="screenshots/screenshot-23-1.png" alt="Click to watch on YouTube" /></a>
2023-10-03 05:37:41 -04:00
2023-10-04 08:38:42 -04:00
<a href="https://youtu.be/ELEQh0z3lm8" target="_blank"><img src="screenshots/screenshot-23-2.png" alt="Click to watch on YouTube" /></a>
2023-10-03 05:37:41 -04:00
2023-10-04 08:38:42 -04:00
<a href="https://youtu.be/ELEQh0z3lm8" target="_blank"><img src="screenshots/screenshot-23-3.png" alt="Click to watch on YouTube" /></a>
2023-10-03 05:37:41 -04:00
2023-10-04 08:38:42 -04:00
<a href="https://youtu.be/ELEQh0z3lm8" target="_blank">Watch on YouTube</a>
2023-08-31 12:11:09 -04:00
2023-08-31 12:12:40 -04:00
<b><a href="https://gitlab.com/stephan-raabe/dotfiles/-/tree/main/screenshots?ref_type=heads">You can find more screenshots here.</a></b>
2023-01-22 12:27:01 -05:00
2023-02-18 10:48:07 -05:00
## Getting started
2023-01-22 12:27:01 -05:00
2023-02-18 11:02:06 -05:00
To make it easy for you to get started with my dotfiles, here's a list of recommended next steps.
2023-01-22 12:27:01 -05:00
2023-10-03 05:37:41 -04:00
PLEASE BACKUP YOUR EXISTING .config WITH YOUR DOTFILES BEFORE STARTING THE SCRIPTS.
2023-01-22 12:27:01 -05:00
```
2023-10-03 05:37:41 -04:00
# Make sure that you're in your home directory
cd
2023-09-04 16:20:21 -04:00
# Clone the repository from your home directory
2023-02-18 10:48:07 -05:00
git clone https://gitlab.com/stephan-raabe/dotfiles.git
2023-01-22 12:27:01 -05:00
2023-10-03 05:37:41 -04:00
# Or download the lastest version and unzip into ~/dotfiles folder
2023-09-05 00:31:24 -04:00
# Change into the new dotfiles folder
cd dotfiles
# Install all required packages
2023-02-18 10:48:07 -05:00
./1-install.sh
2023-01-22 12:27:01 -05:00
2023-09-04 16:22:20 -04:00
# Install hyprland window manager
2023-08-31 09:01:03 -04:00
./2-install-hyprland.sh
2023-09-05 00:31:24 -04:00
# OR/AND Install qtile window manager
2023-08-31 09:01:03 -04:00
./2-install-qtile.sh
2023-01-22 12:27:01 -05:00
2023-09-04 16:20:21 -04:00
# Install dotfiles
./3-install-dotfiles.sh
2023-02-18 10:48:07 -05:00
```
2023-10-03 05:37:41 -04:00
Please note that every Arch Linux system is different and I cannot guarantee that everything works fine on your system.
2023-01-22 12:27:01 -05:00