From f47eec2095b15d781dba6b8cc5dcd40b1e2c6432 Mon Sep 17 00:00:00 2001
From: Derisis13 <email.felhasznalasra@gmail.com>
Date: Sat, 2 Nov 2024 23:42:16 +0100
Subject: [PATCH] docs: README/instructions

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..39076d2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# HA5PLS's fedora install documentation
+- partitioning: differs every time
+- dnf: todo (preferences + repos)
+- packages: todo barusu + base system + repo carry
+- alacritty: .config/alacritty/alacritty.toml + fira_code_mono_nerd_font installed (todo: script)
+- zsh: $ZDOTDIR set in /etc/zshenv + omz install (todo:script) + .config/zsh + install fzf-tab plugin (git clone https://github.com/Aloxaf/fzf-tab ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/fzf-tab) + for some reason $XDG_STATE_HOME/zsh needs to be created manually
+- hypr*: .config/hypr
+- hyprpaper: .config/hypr + .local/wallpapers
+- waybar: .config/waybar + install awesomefonts (todo: script)
+- rofi: .config/rofi + extract neccessary parts from https://github.com/adi1090x/rofi install script
+- rofi-qalc: needs rofi-wayland-1.7.5+wayland2-3.fc40.x86_64 (find it in downloads or fedora build system) until ABI is fixed, rofi-devel, then compile this by hand: https://github.com/svenstaro/rofi-calc
+- sddm: dependency: `qt6-qtquickcontrols2 qt6-qtsvg` then `# systemctl set-default graphical.target` -> /etc/sddm.conf & /usr/share/sddm/themes/catppuccin-macchiato/
+- nvim: .config/nvim + alacritty done + deps: clang (gcc-c++), unzip, npm, ripgrep, then proceed with nvchad init
+- swaync: .config/swaync
+- gtk: .config/gtk-*
+- dconf-based: barusu
+- kdeconnect: `# firewall-cmd --permanent --add-service=kdeconnect` + needs kdeconnectd restart to work
+- plymouth: /usr/share/plymouth/themes/fedora-mac-style + plymouth-plugin-two-step and abattis-cantarell-fonts installed + (`plymouth-set-default-theme -l` -> if this displays the theme, installation can begin: `sudo plymouth-set-default-theme -R fedora-mac-style && sudo dracut --regenerate-all -f`)
+- grub: /etc/default/grub + /boot/themes + `grub2-mkconfig -o /boot/grub2/grub.cfg`
+- udev: /etc/udev/rules.d/ (for setting driver permissions)
+- selinux: /etc/selinux/config to stay permissive (why even bother with selinux?)
+- MPV: $XDG_CONFIG_HOME/mpv/
+- QT5: PAIN. No idea. Maybe QT_PLATFORMTHEME, maybe KVANTUM. Still looks like ass.
+- lxd: do I need it? Replace with flatpak quartus & modelsim
+
+# Thanks to:
+- [Kosmx](https://github.com/KosmX/) for providing help and [dotfiles to steal from](https://github.com/KosmX/hypr-dots)
+- [Catpuccin](https://github.com/catppuccin/) for providing a nice theme ported to many platforms.
+- [NvChad](https://github.com/NvChad/) for providing a powerful & extensible neovim config that helps me at my job.
+- [The ani-cli discord](https://discord.com/invite/aqu7GpqVmR) for providing general support and help writing these files.
+- The creators of the tools these config files belong to for providing me all of this free software.
+- Anyone else who I forgot, but stole, copied, yoinked or inspired from or helped me in any other way.