Up

Former-commit-id: 8bda501d16

README.md

@@ -2,13 +2,76 @@
 
 This is my dotfiles repo. It's a work in progress, and I'm still learning how to use nix.
 
-Every things that you *must* change got a "CHANGEME" comment.
-You can search for it with ripgrep: `rg "CHANGEME"`
+# Images
+
+![1](img/1.png)
+![2](img/2.png)
+![3](img/3.png)
+
+# Apps
+
+- File manager:
+  - lf
+  - thunar
+- Terminal: kitty
+- Shell: zsh
+  - Prompt: starship
+  - Bat, eza, zoxide, fzf, ripgrep
+- Editor: nixvim
+- Browser: qutebrowser
+- Music: spictify
+- Bar: waybar
+- Notifications: dunst
+- Launcher: wofi
+- WM: Hyprland
+  - hyprlock
+  - hyprpaper
+  - hypridle
+  - wlogout
+- DM: Tuigreet
+
+# Themes & Colors
+
+Themes and colors are managed by the `home/variable/theme` folder.
+
+# Scripts
+
+## Nix/NixOs shortcuts
+
+- `nixy-edit`
+- `nixy-rebuild`
+- `nixy-gc`
+- `nixy-update`
+
+## Brightness control
+
+- `brightness-up`
+- `brightness-down`
+- `brightness-change <up/down> <increment>`
+
+## Sound control
+
+- `sound-up`
+- `sound-down`
+- `sound-toggle`
+- `sound-output`
+- `sound-change <up/down/mute> <increment>`
+
+# Installation
+
+```sh
+git clone https://github.com/anotherhadi/nixy ~/.config/nixos
+```
+
+- Every things that you *must* change got a "CHANGEME" comment. You can search for it with ripgrep: `rg "CHANGEME"`
+- Change the `nixos/configuration.nix` file to match your system
+- Copy your `hardware-configuration.nix` file to the `nixos` folder
+
+```sh
+sudo nixos-rebuild switch --flake ~/.config/nixos#nixy
+```
 
 # TODOLIST
 
 - [ ] Variable user & homeDir
-- [ ] Ricing things
-  - [ ] Peaclock
-- [ ] Find a tui app for white noises (does that exist ? If not, I'll build my own)
 - [ ] Custom GTK & Qt Theme based on the colorscheme