README.md (3533B)
1 # Dotfiles 2 3 This repository contains my personal configuration files (dotfiles) for various programs. These dotfiles are tailored to my preferences and setup, but you may find them useful as a reference or starting point for your own configurations, so you may use them as you wish! 4 5 ## Warning 6 In my [xinitrc](files/config/X11/xinitrc) I have it set to the UK keyboard layout, so if your keyboard layout is diffrent change it there! 7 8 ## Table of Contents 9 - [Installation](#installation) 10 - [Included Configurations](#included-configurations) 11 - [Contributing](#contributing) 12 - [License](#license) 13 14 ## Installation 15 To install my dotfiles, follow these simple steps: 16 17 1. **Clone the Gitlab Repository:** 18 19 From Gitlab 20 ```sh 21 git clone https://gitlab.com/dotfiles 22 cd dotfiles 23 ``` 24 25 From my website 26 ```sh 27 git clone git://git.shipwreckt.co.uk/dotfiles.git 28 cd dotfiles 29 ``` 30 31 2. **Run the Install Script:** 32 ```sh 33 ./autoinstall.sh 34 ``` 35 This script will install packages I use, set up UFW (Uncomplicated Firewall), install synth shell and yay, set up directories in your home directory, set up the LY display manager, and copy my configuration files to your `.config` plus some `.bashrc` additions I use. 36 37 38 ## Included Configurations 39 This repository includes configurations for the following programs: 40 41 - [LY](https://github.com/fairyglade/ly) - Display Manager 42 - [Dircolors](https://www.gnu.org/software/coreutils/manual/html_node/dircolors-invocation.html) - Adds color in the terminal 43 - [Neovim](https://neovim.io/) - My IDE 44 - [Picom](https://github.com/yshui/picom) - Compositor for X, forked from Compton 45 - [Ranger](https://github.com/ranger/ranger) - TUI-based File Manager with Vim Keybinds 46 - [Redshift](https://github.com/jonls/redshift) - Adjusts the Color Temperature of Your Screen 47 - [DWM](https://dwm.suckless.org/) - Tiling Window Manager 48 - [Dmenu](https://tools.suckless.org/dmenu/) - App Launcher by Suckless 49 - [Slstatus](https://tools.suckless.org/slstatus/) - Status Bar for DWM 50 - [St](https://st.suckless.org/) - Terminal emulator by suckless 51 -- Control k to scroll up 52 -- Control j to scroll down 53 -- Control l to zoom out 54 -- Control h to zoom in 55 - [Fish shell](https://fishshell.com/) - Terminal shell 56 - [Starship](https://starship.rs/) - Terminal bling 57 - [Dunst](https://github.com/dunst-project/dunst) - Notifications 58 59 ## Programs No Longer Used 60 These are programs and tools that I no longer use: 61 62 - [Alacritty](https://github.com/alacritty/alacritty) - Terminal 63 - [Polybar](https://github.com/polybar/polybar) - Simple Status Bar 64 - [Synth Shell](https://github.com/andresgongora/synth-shell) - Terminal Customization and Git Helper 65 - [i3](https://i3wm.org/) - Tiling Window Manager plus i3status 66 - [Qtile](https://qtile.org/) - Tiling Window Manager written in Python 67 - [Rofi](https://github.com/davatorium/rofi) - App Launcher 68 69 ## Contributing 70 Contributions are welcome! However, please note that these are my personal dotfiles, so I will primarily accept changes that align with my preferences and style. 71 72 Feel free to submit pull requests or open issues if needed, and I'll review them as time allows. 73 74 75 ## License 76 As with nearly all of my repositories, this one is licensed under the [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.en.html). I'm including this notice to ensure that the license is clearly stated, in case the license file is not present in the repository. 77 78 Please refer to the [LICENSE](LICENSE) file for detailed information.