From e55a0ca887d241381b52dbee4f86a2b6e59c859f Mon Sep 17 00:00:00 2001 From: ClovertaTheTrilobita Date: Sun, 11 Jan 2026 20:50:55 +0000 Subject: [PATCH] add readme discription --- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ replace.sh | 2 ++ 2 files changed, 62 insertions(+) diff --git a/README.md b/README.md index 40d5329..ce14192 100644 --- a/README.md +++ b/README.md @@ -14,5 +14,65 @@ Okay so lets talk about how to use. ## Installation +### Clean Install + The installation script currently only supports Arch Linux if you are starting from a clean system installation environment. +```shell +git clone https://github.com/ClovertaTheTrilobita/niri-dots.git +chmod +x install.sh +./install.sh +``` + +> [!WARNING] +> +> This script should only be used when you just setup your system and haven't install anything yet. It might (though the possibilities are low) break some of your packages since it'll do packages installations for you. + +### If you already done some configuration + +That's even more simple! + +```shell +chmod +x replace.sh +./replace.sh +``` + +This will replace some of your config files (It will make backups). + +> [!NOTE] +> +> This script doesn't do any installations, so you need to install all packages by your self. + +### Manual installation + +I guess this dot might be a bit too easy to use a installation script. + +#### Arch Linux + +##### 1. Install packages + +```shell +yay -S --needed cava fastfetch fuzzel kitty mako niri swaylock-fancy-git swaync waybar wlogout wofi sddm +``` + +##### 2. Copy configuration files + +copy all folders in `.config` to your own `XDG_CONFIG_HOME` (mostly `~/.config`) + +##### 3. Setup grub theme + +if you want to use the grub theme + +```shell +cd matter +./matter.py +``` + +##### 4.SDDM theme + +I recommend using this sddm theme [Keyitdev/sddm-astronaut-theme](https://github.com/Keyitdev/sddm-astronaut-theme). You can install it with simply + +``` +bash -c "$(curl -fsSL https://raw.githubusercontent.com/keyitdev/sddm-astronaut-theme/master/setup.sh)" +``` + diff --git a/replace.sh b/replace.sh index 0eacbfb..29c5605 100644 --- a/replace.sh +++ b/replace.sh @@ -4,6 +4,8 @@ set -euo pipefail echo "This is a really simple script that helps you move all config files into place." echo "So you don't need to replace them one by one." +echo "Make sure you have the following packages installed (if you want to use them):" +echo "cava fastfetch fuzzel kitty mako niri swaylock swaync waybar wlogout wofi sddm" echo "Do you wish to continue?[y/N]"