Skip to content

Latest commit

 

History

History
89 lines (73 loc) · 4.32 KB

README.md

File metadata and controls

89 lines (73 loc) · 4.32 KB

Arch Hyprland Dotfiles

2024-09-03_14:59:13

Welcome!

You’ve stumbled upon my personal Arch Hyprland dotfiles. This repository includes custom scripts and configurations for many programs, including fish, pywal, kitty, waybar, rofi, spicetify, waycorner, and more. See the Repository Structure section below for more information.

If you are looking for pre-made dotfiles you can simply install and use immediately, this isn't the repository for you.

Otherwise, welcome to the rabbit-hole. Remember to stay hydrated, and good luck!

Key Features

In addition to a carefully crafted Hyprland setup with extensive useful keybindings, notable features include:

  • a robust fish shell configuration
  • a custom pywal script that can use random images from unsplash.com, which works seamlessly with a (growing) collection of well-integrated pywal templates
  • useful and easy to understand scripts for essential system utilities/tools

Although this is (indefinitely) a WIP, my goal is to make this repository as informative as possible, and I am working on adding clear descriptions, comments, and notes for every file.

Repository Structure

The structure is pretty straightforward. The files in this repository are organized to reflect their actual system paths:

  • home/: The real heart of this repository. Contains user-specific config files. All referenced scripts are included in home/.config/hypr/scripts/. Additional useful scripts/functions can be found in home/.config/fish/.
  • etc/: Critical system-wide config files for programs like pacman and sudo.
Directory tree
This is only a simplified overview and does not include all subdirectories.
├── etc
│   ├── pacman.d
│   └── sudoers.d
└── home
    └── .config
        ├── bat
        ├── bleachbit
        ├── broot
        ├── btop
        ├── cava
        ├── clipse
        ├── Code - OSS
        ├── dunst
        ├── fastfetch
        ├── fish
        ├── gtk-3.0
        ├── gtk-4.0
        ├── hypr
        ├── kitty
        ├── Kvantum
        ├── micro
        ├── npm
        ├── qt6ct
        ├── ripgrep
        ├── rofi
        ├── spicetify
        ├── swappy
        ├── swaylock
        ├── swaync
        ├── terminal-colors.d
        ├── wal
        ├── waybar
        ├── waycorner
        ├── wlogout
        ├── yay
        └── zathura

How to Get Started

⚠️ Proceed with Caution!

A few words of caution for anyone new to dotfiles: this isn't a "copy and paste" situation, and I'm not just referring to this repository. In general, it's obviously not a good idea to copy random files you find online to your system without knowing what you're doing. If you’re not careful, blindly copying someone else's dotfiles could break your system. Please be mindful when applying any changes. That said, here's how you can safely make use of this repository:

  • Clone the Repo:

    git clone https://github.com/NaturalBornCyborg/dot_dot_dots.git
  • Enter the rabbit-hole. Take your time exploring, and try things out incrementally.

  • If you find something that suits your needs, backup any existing configs before trying out new ones.

  • RTFM. In addition to resources like the Arch Wiki, take advantage of all the excellent documentation already available on your system. Make man your best friend. wikiman is also a great tool.

  • Ask questions. I can't speak for everyone who publicly shares their dotfiles, but I would personally be thrilled to hear from you (and I'm sure many others feel the same way). Or if you prefer, there are countless active wikis, communities, and forums full of knowledge. All of those options are better than asking ChatGPT btw.

  • If you have questions, suggestions, ideas, or would like to discuss collaboration, my email is listed on my GitHub profile. Please also feel free to utilize this repository's issues/pull requests/discussions.

License

This project is licensed under the terms of the GNU General Public License v3.0. See the LICENSE file for more details.

Happy ricing!