Home
Welcome to the documentation for my dotfiles repository. This project contains personalized configurations for various development tools and desktop environments on Linux. It is designed to be modular, user-friendly, and adaptable to different setups.
Follow these steps to set up the entire system automatically:
git clone --branch main https://github.com/Deivis44/dotfiles.git ~/dotfiles
cd ~/dotfiles
chmod +x Scripts/full_installer_v2.sh
./Scripts/full_installer_v2.shIf you only need to set up symbolic links for the dotfiles:
chmod +x Scripts/stow-links.sh
./Scripts/stow-links.shThe repository is organized as follows:
-
Config/: Configurations for specific tools like
git,nvim,tmux, etc. - Resources/: Visual resources such as fonts, wallpapers, and screenshots.
- Scripts/: Scripts for installation, configuration, and dotfile management.
- Workflow/: Backups and additional configurations for workflows.
Before using this repository, ensure you have the following:
- Bash 4+: Required for associative arrays.
- Git: To clone the repository.
- Linux Environment: Tested on Arch Linux but adaptable to other distributions.
-
Permissions: Read access to
~/dotfiles/Configand execution permissions for scripts.
This project offers:
- Modular Configurations: Easily adapt settings to your needs.
- Cross-System Compatibility: Maintain consistent configurations across multiple systems.
- Interactive Scripts: User-friendly scripts for managing symbolic links and installations.
- Visual Customization: Includes themes, wallpapers, and fonts for a personalized experience.
| Window Manager | Terminal | Music Player |
|---|---|---|
 |
 |
 |
| File Manager | Browser | Lock Screen |
|---|---|---|
 |
 |
 |
Explore the complete documentation to better understand the project:
- Project Structure: Detailed description of folders and files.
- Usage Guide: Step-by-step instructions for using the scripts.
- Scripts: Specific documentation for each script.
- FAQ: Frequently asked questions and troubleshooting.
- Contributing: Guide for contributing to the project.
This project includes optimized configurations for:
- Shell: Zsh with Starship prompt for a modern experience.
- Editor: Neovim with plugins and custom settings.
- Terminal: Kitty with themes and custom shortcuts.
- Multiplexer: Tmux with productivity-focused configurations.
- Window Manager: Hyprland (Wayland) for a minimalist graphical environment.
- File Explorer: Ranger with file preview.
- PDF Viewer: Zathura, minimalist and fast.
If you encounter issues or have questions, you can:
- Check the FAQ: Find answers to common questions.
- Open a GitHub Issue: Report bugs or request features here.
- Contact the Maintainer: Reach out via the repository's contact information.
Want to improve this project? Check out the contribution guide to learn how to collaborate. All contributions are welcome, from reporting bugs to proposing new features.
This project is licensed under the MIT License. See LICENSE for more details.
Note: This documentation is designed to be compatible with GitHub Wiki. To migrate to Wiki, copy the content of these files to the corresponding pages in your repository's Wiki tab.