cloverta/niri-dots
1
0
Fork 0
mirror of https://github.com/ClovertaTheTrilobita/niri-dots.git synced 2026-04-01 22:04:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add readme discription

Browse source
This commit is contained in:
ClovertaTheTrilobita 2026-01-11 20:50:55 +00:00
parent 4e8276c15c
commit e55a0ca887
2 changed files with 62 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -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)"
```

2
replace.sh
View file

@ -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]"