Initial commit - created with claude AI
This commit is contained in:
233
README.md
Normal file
233
README.md
Normal file
@@ -0,0 +1,233 @@
|
||||
# 🎨 HYPRARCH
|
||||
|
||||
A minimal, beautiful Hyprland rice for Arch Linux with Nord color scheme.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## ✨ Features
|
||||
|
||||
- 🪟 **Hyprland** - Dynamic tiling Wayland compositor with smooth animations
|
||||
- 📊 **Waybar** - Minimal status bar with Nord styling
|
||||
- 🚀 **Rofi** - Beautiful app launcher
|
||||
- 🖥️ **Kitty** - GPU-accelerated terminal
|
||||
- 🔔 **Dunst** - Clean notification daemon
|
||||
- 🖼️ **SWWW** - Animated wallpaper daemon
|
||||
- 🔒 **Hyprlock** - Stylish lock screen
|
||||
- 🎨 **Nord Theme** - Cohesive color scheme throughout
|
||||
|
||||
## 📸 Screenshots
|
||||
|
||||
*Coming soon*
|
||||
|
||||
## ⚡ Quick Install
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://git.cribdev.com/hyprarch/hyprarch.git ~/hyprarch
|
||||
|
||||
# Run the install script
|
||||
cd ~/hyprarch
|
||||
chmod +x install.sh
|
||||
./install.sh
|
||||
|
||||
# Log out and select Hyprland, or start from TTY:
|
||||
Hyprland
|
||||
```
|
||||
|
||||
That's it! The script handles everything automatically.
|
||||
|
||||
## 📦 What Gets Installed
|
||||
|
||||
### Core
|
||||
- Hyprland, Hyprpaper, Hyprpicker, Hypridle, Hyprlock
|
||||
- Waybar, Rofi, Dunst, SWWW
|
||||
- XDG Desktop Portal for Hyprland
|
||||
|
||||
### Utilities
|
||||
- Kitty (terminal)
|
||||
- Thunar (file manager)
|
||||
- PipeWire (audio)
|
||||
- NetworkManager, Blueman (connectivity)
|
||||
|
||||
### CLI Tools
|
||||
- Neovim, Zsh, Starship prompt
|
||||
- eza, bat, fzf, ripgrep, fd
|
||||
|
||||
### Applications
|
||||
- Firefox, MPV, Zathura (PDF)
|
||||
|
||||
## ⌨️ Keybindings
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `SUPER + Return` | Terminal (Kitty) |
|
||||
| `SUPER + D` | App Launcher (Rofi) |
|
||||
| `SUPER + Q` | Close Window |
|
||||
| `SUPER + E` | File Manager |
|
||||
| `SUPER + V` | Toggle Floating |
|
||||
| `SUPER + F` | Fullscreen |
|
||||
| `SUPER + L` | Lock Screen |
|
||||
| `SUPER + M` | Exit Hyprland |
|
||||
| `SUPER + 1-9` | Switch Workspace |
|
||||
| `SUPER + SHIFT + 1-9` | Move to Workspace |
|
||||
| `SUPER + SHIFT + S` | Screenshot (select) |
|
||||
| `Print` | Screenshot to file |
|
||||
|
||||
## 📁 File Structure
|
||||
|
||||
```
|
||||
hyprarch/
|
||||
├── install.sh # Main install script
|
||||
├── README.md # This file
|
||||
├── .config/
|
||||
│ ├── hypr/
|
||||
│ │ ├── hyprland.conf # Main Hyprland config
|
||||
│ │ └── hyprlock.conf # Lock screen config
|
||||
│ ├── waybar/
|
||||
│ │ ├── config # Waybar modules
|
||||
│ │ └── style.css # Nord themed styling
|
||||
│ ├── rofi/
|
||||
│ │ ├── config.rasi # Rofi config
|
||||
│ │ └── nord.rasi # Nord theme
|
||||
│ ├── kitty/
|
||||
│ │ └── kitty.conf # Terminal config
|
||||
│ └── dunst/
|
||||
│ └── dunstrc # Notification config
|
||||
└── wallpapers/ # Wallpaper collection
|
||||
```
|
||||
|
||||
## 🎨 Color Scheme (Nord)
|
||||
|
||||
| Color | Hex | Usage |
|
||||
|-------|-----|-------|
|
||||
| Polar Night | `#2e3440` | Background |
|
||||
| Snow Storm | `#eceff4` | Foreground |
|
||||
| Frost | `#88c0d0` | Accent/Active |
|
||||
| Aurora Red | `#bf616a` | Critical/Error |
|
||||
| Aurora Green | `#a3be8c` | Success |
|
||||
| Aurora Yellow | `#ebcb8b` | Warning |
|
||||
|
||||
## 🔧 Customization
|
||||
|
||||
### Change Wallpaper
|
||||
```bash
|
||||
swww img ~/Pictures/wallpapers/your-wallpaper.jpg --transition-type grow
|
||||
```
|
||||
|
||||
### Edit Configs
|
||||
```bash
|
||||
# Hyprland
|
||||
nvim ~/.config/hypr/hyprland.conf
|
||||
|
||||
# Waybar
|
||||
nvim ~/.config/waybar/config
|
||||
nvim ~/.config/waybar/style.css
|
||||
|
||||
# Rofi
|
||||
nvim ~/.config/rofi/nord.rasi
|
||||
|
||||
# Kitty
|
||||
nvim ~/.config/kitty/kitty.conf
|
||||
```
|
||||
|
||||
### Change Theme Colors
|
||||
Edit the color variables in:
|
||||
- `~/.config/waybar/style.css`
|
||||
- `~/.config/rofi/nord.rasi`
|
||||
- `~/.config/kitty/kitty.conf`
|
||||
- `~/.config/dunst/dunstrc`
|
||||
|
||||
## 🔍 Troubleshooting
|
||||
|
||||
### Hyprland won't start
|
||||
```bash
|
||||
# Check if running Wayland
|
||||
echo $XDG_SESSION_TYPE
|
||||
|
||||
# Check Hyprland logs
|
||||
cat /tmp/hypr/*/hyprland.log
|
||||
```
|
||||
|
||||
### Waybar not showing
|
||||
```bash
|
||||
# Restart waybar
|
||||
killall waybar
|
||||
waybar &
|
||||
```
|
||||
|
||||
### No sound
|
||||
```bash
|
||||
# Check PipeWire
|
||||
systemctl --user status pipewire pipewire-pulse wireplumber
|
||||
|
||||
# Restart audio
|
||||
systemctl --user restart pipewire pipewire-pulse wireplumber
|
||||
```
|
||||
|
||||
### Wallpaper not loading
|
||||
```bash
|
||||
# Check if swww daemon is running
|
||||
pgrep swww
|
||||
|
||||
# Start daemon and set wallpaper
|
||||
swww-daemon &
|
||||
sleep 1
|
||||
swww img ~/Pictures/wallpapers/default.jpg
|
||||
```
|
||||
|
||||
### Rofi not opening
|
||||
```bash
|
||||
# Test rofi
|
||||
rofi -show drun
|
||||
|
||||
# Check if rofi-wayland is installed
|
||||
pacman -Qs rofi
|
||||
```
|
||||
|
||||
## 🔄 Updating
|
||||
|
||||
```bash
|
||||
cd ~/hyprarch
|
||||
git pull
|
||||
./install.sh
|
||||
```
|
||||
|
||||
Your custom configs will be backed up before updating.
|
||||
|
||||
## 🗑️ Uninstall
|
||||
|
||||
```bash
|
||||
# Remove configs
|
||||
rm -rf ~/.config/hypr
|
||||
rm -rf ~/.config/waybar
|
||||
rm -rf ~/.config/rofi
|
||||
rm -rf ~/.config/kitty
|
||||
rm -rf ~/.config/dunst
|
||||
|
||||
# Optionally remove packages (be careful!)
|
||||
# sudo pacman -Rns hyprland waybar rofi kitty dunst swww
|
||||
```
|
||||
|
||||
## 📚 Resources
|
||||
|
||||
- [Hyprland Wiki](https://wiki.hyprland.org/)
|
||||
- [Nord Theme](https://www.nordtheme.com/)
|
||||
- [Arch Wiki - Hyprland](https://wiki.archlinux.org/title/Hyprland)
|
||||
|
||||
## 🤝 Credits
|
||||
|
||||
- [Hyprland](https://hyprland.org/) by vaxerski
|
||||
- [Nord Theme](https://www.nordtheme.com/) by Arctic Ice Studio
|
||||
- [Nordic Wallpapers](https://github.com/linuxdotexe/nordic-wallpapers)
|
||||
|
||||
## 📄 License
|
||||
|
||||
MIT License - Feel free to use and modify!
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
Made with 💙 for the Arch + Hyprland community
|
||||
</p>
|
||||
Reference in New Issue
Block a user