diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 9 insertions, 4 deletions
@@ -1,7 +1,12 @@ -# .files -These are all the config files for the programs I use on the daily. Since I tend to use several machines each running different instances of linux, I created this repository so I would only have to clown it and use GNU-stow as follows, - +# .* +These are the config files I've accumulated for the programs I use on a daily basis. Since I regularly use multiple machines, I keep my dotfiles in this repository so I can clone it and just use `stow`. Running `stow` simply symlinks all the files in this repository into your home directory. ```sh -$ git clone https://github.com/Hachem-H/dotfiles.git +$ git clone https://github.com/im-hachem/dotfiles.git $ cd dotfiles && stow . ``` + +## Maintenance +I don't distro hop or modify my configs particularly often, so this repository doesn't receive frequent updates. I primarily use these configs between my main machine running macOS and my secondary machines running NixOS/Arch. Because of that, not every config file in this repository is actively used or maintained, and some files may be outdated. For example, I rarely ever use tiling window managers nowadays, so my `i3`/`polybar` config is generally never used. The config files that tend to stay up to date are mainly whichever terminal emulator I'm using, Neovim, Zsh, and a couple of scripts under `~/.local`. Some config files are mostly here for historical reasons or because I may still find them useful when setting up another machine. + +## Note +This repository is primarily for my own convenience rather than a collection of universally useful, tasteful, or beautiful configs. Some of the files may contain machine-specific assumptions, old things, or stuff that only makes sense in my particular environment. If you happen to find something useful in here, then great. Otherwise, don't expect a [r/unixporn](https://reddit.com/r/unixporn) level rice. |