add README with basic instructions
This commit is contained in:
parent
ea2e6747d9
commit
e2a5332a93
1 changed files with 19 additions and 0 deletions
19
README.md
Normal file
19
README.md
Normal file
|
@ -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/)
|
Reference in a new issue