dotfiles/README.md

38 lines
1.2 KiB
Markdown
Raw Normal View History

2021-10-02 20:59:11 +00:00
# My dotfiles
2022-09-25 15:16:01 +00:00
This is a collection of some of my dotfiles for my Linux systems. They
2022-09-18 19:04:42 +00:00
work on Artix, Debian, Fedora and Ubuntu.
2021-10-02 20:59:11 +00:00
2022-01-26 13:42:41 +00:00
To install:
2021-10-02 20:59:11 +00:00
2022-06-06 18:45:09 +00:00
```console
2022-06-06 14:21:38 +00:00
$ git clone https://git.data.coop/samsapti/dotfiles.git
2021-10-02 20:59:11 +00:00
$ cd dotfiles
2022-03-05 19:51:07 +00:00
$ ./install.sh
2021-10-02 20:59:11 +00:00
```
2022-06-06 14:20:48 +00:00
Note that I use `doas` instead of `sudo` (only on Artix). If you prefer
`sudo`, then change all instances of `doas` to `sudo`, or simply create
a symlink `doas` pointing to `sudo`:
2021-10-02 20:59:11 +00:00
2022-06-06 18:45:09 +00:00
```console
2022-06-06 18:50:14 +00:00
$ sudo ln -s $(which sudo) /usr/bin/doas
2021-12-30 14:38:46 +00:00
```
2021-10-02 20:59:11 +00:00
2022-06-06 16:24:49 +00:00
### Notes
2022-06-06 14:20:48 +00:00
- You need to make `doas`/`sudo` rules that allow you to execute,
2022-09-25 15:16:01 +00:00
`poweroff` and `reboot` without a password, otherwise the
2022-06-06 14:20:48 +00:00
keybindings and scripts for those won't work.
2022-09-25 15:16:01 +00:00
- The installation script requires GNU Stow to work.
2022-06-06 14:20:48 +00:00
- Make sure to thoroughly examine these dotfiles and change them to your
needs before using them.
- See the READMEs in the individual subfolders here for special notes.
2022-06-06 14:20:48 +00:00
- I use `dash` instead of `sh` or `bash` for my shell scripts. As such,
all my scripts try to be as POSIX compliant as possible. If you don't
want to use `dash`, you can change the shebang in the scripts to
`#!/bin/sh` or `#!/bin/bash`.
2022-06-06 16:24:49 +00:00
## License
The [Unlicense](https://git.data.coop/samsapti/dotfiles/src/branch/main/LICENSE).