first commit

README.md

@@ -0,0 +1,50 @@
+Jeena's Hyprland setup
+======================
+
+This git repo hosts all the dotfiles I need for my hyprland setup. You
+can use it to learn and to copy from it, but you probably don't want
+to just use it as it is because it's very opinionated and hard coded.
+
+If you want a readymade one then I'd suggest https://omarchy.org/
+
+Install
+=======
+
+You need to clone this git repository to your computer, let's assume
+you do:
+
+```
+mkdir -p ~/Projects/
+cd ~/Projects/
+git clone https://git.jeena.net/jeena/hypr-dotfiles.git
+```
+
+Then you need to soft link the directories in this git repo to the
+`~/.config/` directory, make sure that those directories don't exist
+yet in your `~/.config`, you will need to delete or move them
+before. In our example it would be:
+
+```
+cd ~/config
+ln -s ~/Projects/hypr-dotfiles/hypr hypr
+ln -s ~/Projects/hypr-dotfiles/waybar waybar
+ln -s ~/Projects/hypr-dotfiles/tofi tofi
+```
+
+You also need to install all the dependencies:
+
+- hyprland
+- tofi
+- waybar
+- nmtui
+- python3
+- Curved Square font https://www.1001freefonts.com/curved-square.font
+- FontAwesome
+
+There are probably more, I will update the list next time I'm
+installing it on a new computer.
+
+License
+=======
+
+All scripts here are under the GPL-v3 or a later version.