diff --git a/README.md b/README.md index 843a6b8..21635e9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # dotfiles & system setup -``` +```shell +arch-linux > arch specific dotfiles bin > helpful shell scripts git > global git config & aliases gnupg > utilise gpg-agent for pgp crypto @@ -24,16 +25,29 @@ zsh > shell, aliases and cool stuff Clone repository, then setup as desired using [GNU Stow][url-gnu-stow]. +## Caveats + +These dotfiles assume the computer is set up in a specific way. I recommend +using Ansible or other tools (Chef, Puppet, etc) to automatically provision +your computer the way you like it. + +The following should really be Ansible playbooks: + +- mail (setup systemd units) +- ssh (add ssh keys & server aliases) +- system (modify files out of `$HOME`) + ## Further Reading -* [Mozilla OpenSSH security guidelines][url-mozilla-ssh] -* [Good read on securing OpenSSH][url-secure-shell] - +- [Using GNU Stow to manage your dotfiles][url-invergo-stow] +- [Mozilla OpenSSH security guidelines][url-mozilla-ssh] +- [Good read on securing OpenSSH][url-secure-shell] ## LICENSE The MIT License ([MIT](LICENSE.md)) -[url-gnu-stow]:https://www.gnu.org/software/stow/ -[url-mozilla-ssh]:https://wiki.mozilla.org/Security/Guidelines/OpenSSH -[url-secure-shell]:https://stribika.github.io/2015/01/04/secure-secure-shell.html +[url-gnu-stow]: https://www.gnu.org/software/stow/ +[url-invergo-stow]: http://brandon.invergo.net/news/2012-05-26-using-gnu-stow-to-manage-your-dotfiles.html +[url-mozilla-ssh]: https://wiki.mozilla.org/Security/Guidelines/OpenSSH +[url-secure-shell]: https://stribika.github.io/2015/01/04/secure-secure-shell.html