feat: add README.md with installation instructions

This commit is contained in:
2025-05-28 22:07:27 +02:00
parent e877b6c013
commit fdcd4df144
2 changed files with 26 additions and 1 deletions

3
.gitignore vendored
View File

@ -11,4 +11,5 @@
!.zshrc
!.zshenv.template
!.profile
!install
!install
!README.md

24
README.md Normal file
View File

@ -0,0 +1,24 @@
# My motherfucking dotfiles
## Installation
```bash
# Clone the Repository
git clone https://git.simonis.lol/csimonis/dotfiles.git ~/dotfiles
cd ~/dotfiles
# Install Script uses apt so if your not root get fucked idiot
if [ "$(id -u)" -ne 0 ]; then
alias apt='sudo apt'
fi
# Installs system dependencies and does some other stuff
./install
# Creates Symlinks and installs zsh themes and plugins
./setup
```
## Contributing
### If you want to contribute for whatever fucking reasion go fuck yourself