Create README.md

[i3-setup.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..bfe63b2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# i3-setup
+My personal i3-gaps setup for  Ubuntu.
+
+Installs zsh, oh-my-zsh, kitty, i3-gaps, picom, feh, lua, batcat, lolcat, cowsay, fortune.
+Includes a custom zsh theme, kitty configuration, i3-gaps configuration, and a custom cat program written in lua.
+
+This works perfectly fine when installing it on an already fully set up desktop environment (like KDE Plasma) without affecting the already installed environment; however it will nuke your zshrc.
+You should probably install ssdm unless you already have a different desktop environment installed.