diff --git a/README.md b/README.md new file mode 100644 index 0000000..e7efe9f --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Dotfiles from [Spaenny](https://spenny.tf) + +> All needed Dotfiles to get my system back to a usable state + +## Install + +### Requirements + +You will need atleast following packages for it to work + +`paru -S chezmoi nvim alacritty plasma-meta zsh` + +### Getting started + +For chezmoi to restore the old state you have to run following command. + +`chezmoi init --apply --verbose https://git.snrd.eu/Spaenny/dotfiles.git` + +WARNING: This will instantly apply my Dotfiles to your machine, for further information how todo this step by step checkout: [chezmoi documentation](https://www.chezmoi.io/user-guide/setup/)