diff --git a/README.md b/README.md new file mode 100644 index 0000000..5fa3ce1 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# (dot)Dotfiles + +## Installing + +Install stow first, via the package manager (`apt/dnf install`, `yay/pacman -S stow`, `apk add stow`, so on) + +```bash +# Clone the repository +git clone --recursive git@git.i-am.nexus:nex/.dotfiles $HOME/.dotfiles + +# Install main dotfiles +cd $HOME/.dotfiles/ +stow . + +# Optionally, install additional system-wide configuration things, such as NetworkManager settings. +$HOME/.dotfiles/.install-extras.sh +``` +