dotfiles/README.md

28 lines
1.1 KiB
Markdown

# My dotfiles
This is a collection of some of my dotfiles for my Artix Linux system.
![Screenshot](./.img/screenshot.png)
You can install these dotfiles by cloning this repository and executing `install.sh`:
```bash
$ git clone https://github.com/theanonymousexyz/dotfiles.git
$ cd dotfiles
$ chmod +x install.sh
$ ./install.sh
```
Note that I use `doas` instead of `sudo`. If you prefer `sudo`, then change all instances of `doas` to `sudo`, or simply create a symlink `doas` pointing to `sudo`:
```bash
sudo ln -s $(which sudo) /usr/bin/doas
```
**Notes:**
- You need to make `doas`/`sudo` rules that allow you to execute, `poweroff` and `reboot` (and additionally `ivpn-service` and `pkill "^ivpn-service$"` if you use IVPN) without a password, otherwise the keybindings and scripts for those won't work.
- The install script requires GNU Stow to work.
- Make sure to thoroughly examine these dotfiles and change them to your needs before using them.
- See the READMEs for some of the packages here for special notes.
- Optionally fork this repository to make maintenance easier.