diff --git a/README.md b/README.md index d3b374d..8481f3c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,27 @@ dotfiles ======== -Here be dotfiles. +Managed by [chezmoi][1], a dotfile manager. +To install, grab a binary copy of chezmoi. Then run: + +``` +chezmoi init https://git.sr.ht/~iptq/dotfiles --apply +``` + +This will clone and perform initial installation of all required software packages. Re-login may be necessary. + +Features +-------- + +- zsh + + reminds you to update the system every week + +Contact +------- + +License: GPL + +Author: Michael Zhang + +[1]: https://www.chezmoi.io/