diff --git a/.gitignore b/.gitignore index 3ea46b4..524fd25 100644 --- a/.gitignore +++ b/.gitignore @@ -11,4 +11,5 @@ !.zshrc !.zshenv.template !.profile -!install \ No newline at end of file +!install +!README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..397ad3a --- /dev/null +++ b/README.md @@ -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 \ No newline at end of file