hachem.wtf
aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhachem <im@hachem.wtf>2026-08-30 18:24:10 +0200
committerhachem <im@hachem.wtf>2026-08-30 18:24:10 +0200
commitaf022e654ec50dff762ae4a211cd8f09aab82ee5 (patch)
tree4a689a9ef78f37c15915bdbef1f918434394995e /README.md
parentf3e8791940e23892d8260b3a7cbdeb32f4b29054 (diff)
add: update nvim
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index e9f9075..fd9ccc6 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,13 @@
# .*
-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.
+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 set everything up with a single command.
+
```sh
$ git clone https://github.com/hachem-wtf/dotfiles.git
-$ cd dotfiles && stow .
+$ cd dotfiles && ./install.sh
```
+The installation script symlinks the files in this repository into your home directory using `stow` and installs a few external scripts I use.
+
## 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.