From 8b2f8c08d3095d2db7a7292b96eee9d3230b01b0 Mon Sep 17 00:00:00 2001 From: Hadi <112569860+anotherhadi@users.noreply.github.com> Date: Mon, 17 Jun 2024 16:23:03 +0200 Subject: [PATCH] update --- README.md | 140 +----------------- docs/apps.md | 36 +++++ docs/scripts.md | 86 +++++++++++ .../scripts/create_guest_config.sh | 0 docs/scripts/create_readme.sh | 1 + docs/scripts/install.sh | 0 docs/src/README_template.md | 71 +++++++++ docs/themes.md | 24 +++ home/laptop.nix | 1 + 9 files changed, 222 insertions(+), 137 deletions(-) create mode 100644 docs/apps.md create mode 100644 docs/scripts.md rename {hosts/shared => docs}/scripts/create_guest_config.sh (100%) create mode 100644 docs/scripts/create_readme.sh create mode 100644 docs/scripts/install.sh create mode 100644 docs/src/README_template.md create mode 100644 docs/themes.md diff --git a/README.md b/README.md index 4427cc9..5b146c5 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ It's a simple way to manage your system configuration and dotfiles. ## Table of Contents - [Gallery](#gallery) -- [Architechture](#architechture) +- [Architecture](#architechture) - [Settings, Themes and colors](#settings-themes-and-colors) - [Scripts](#scripts) - [Nix/NixOs shortcuts](#nixnixos-shortcuts) @@ -54,7 +54,7 @@ It's a simple way to manage your system configuration and dotfiles. ![spotify](https://image.nostr.build/76b18bcbcdf1d911a2dbdff7bfac6652044d45602a3dce9d9c53feb295d13245.jpg) ![wofi](https://image.nostr.build/90d69ffe6251c17e25b0fb44abadaeb0dfe6db8210d935fca14bf8b00be49fa6.jpg) -## Architechture +## Architecture - `home` are the dotfiles and configuration files for the user - `hosts` are the system configuration files @@ -64,148 +64,14 @@ It's a simple way to manage your system configuration and dotfiles. - `shared` are some nix files that you can import (nvidia, prime, fonts, ...) - `secrets` are the secrets files encrypted with sops -
-Click to show installed apps - -| Category | Software | -|----------------|---------------| -| WM | Hyprland | -| | hyprlock | -| | hyprpaper | -| | hypridle | -| | wlogout | -| Bar | waybar | -| Terminal | kitty | -| Shell | zsh | -| | tmux | -| | starship | -| | bat | -| | eza | -| | zoxide | -| | fzf | -| Editor | neovim(nixvim)| -| File manager | lf | -| | thunar | -| Browser | qutebrowser | -| Music | spicetify | -| Notifications | dunst | -| Launcher | wofi | -| DM | tuigreet | -| Secrets | sops-nix | -| Misc | lazygit | -| | neofetch | -| | cava | -| | ... | - -
- -## Settings, Themes and colors - -In your hosts configuration, you should add a `variables.nix` file to manage your settings, including: - -- user information -- timezone and locale -- keyboard layout -- the theme: will be used in programs and for GTK and QT themes -- ... (check the `hosts/guest/variables.nix` file for more information) - -PS: To apply the theme to duckduckgo, follow the instructions in `$HOME/.duckduckgo-colorscheme.js`. - -## Scripts - -### Nix/NixOs shortcuts - -
-Click to expand - -- `nixy-edit` -- `nixy-rebuild` -- `nixy-update` -- `nixy-gc` # garbage collection -- `nixy-cb` # clean boot menu - -
- -### Brightness control - -
-Click to expand - -- `brightness-up` -- `brightness-down` -- `brightness-change ` - -
- -### Sound control - -
-Click to expand - -- `sound-up` -- `sound-down` -- `sound-toggle` -- `sound-output` -- `sound-change ` - -
- -### Caffeine - -
-Click to expand - -Caffeine is a simple script that toggles hypridle (disable suspend & screenlock). - -- `caffeine` # Toggle caffeine -- `caffeine-status` # Return active/inactive - -
- -### Night-Shift - -
-Click to expand - -Blue light filter, using wlsunset - -- `night-shift-on` -- `night-shift-off` - -
- -### Nerdfont FZF - -
-Click to expand - -Nerdfont fzf is a quick way to search for nerdfont icons locally. -It will copy the selected icon to the clipboard. - -- `nerdfont-fzf` - -
- -### Compress/Extract - -
-Click to expand - -Some shortcut to compress and extract files. - -- `compress` ... -- `extract` ... - -
- ## Installation/build ```sh git clone https://github.com/anotherhadi/nixy ~/.config/nixos ``` -*let me cook this* - Change the username in the flake.nix file +- import the guest configuration instead of the `hosts/laptop` one - import your hardware-configuration.nix into the `hosts/guest` folder ```sh diff --git a/docs/apps.md b/docs/apps.md new file mode 100644 index 0000000..1749f9b --- /dev/null +++ b/docs/apps.md @@ -0,0 +1,36 @@ + +
+Click to show installed apps + +| Category | Software | +|----------------|---------------| +| WM | Hyprland | +| | hyprlock | +| | hyprpaper | +| | hypridle | +| | wlogout | +| Bar | waybar | +| Terminal | kitty | +| Shell | zsh | +| | tmux | +| | starship | +| | bat | +| | eza | +| | zoxide | +| | fzf | +| Editor | neovim(nixvim)| +| File manager | lf | +| | thunar | +| Browser | qutebrowser | +| Music | spicetify | +| Notifications | dunst | +| Launcher | wofi | +| DM | tuigreet | +| Secrets | sops-nix | +| Misc | lazygit | +| | neofetch | +| | cava | +| | ... | + +
+ diff --git a/docs/scripts.md b/docs/scripts.md new file mode 100644 index 0000000..9df12a0 --- /dev/null +++ b/docs/scripts.md @@ -0,0 +1,86 @@ +## Scripts + +### Nix/NixOs shortcuts + +
+Click to expand + +- `nixy-edit` +- `nixy-rebuild` +- `nixy-update` +- `nixy-gc` # garbage collection +- `nixy-cb` # clean boot menu + +
+ +### Brightness control + +
+Click to expand + +- `brightness-up` +- `brightness-down` +- `brightness-change ` + +
+ +### Sound control + +
+Click to expand + +- `sound-up` +- `sound-down` +- `sound-toggle` +- `sound-output` +- `sound-change ` + +
+ +### Caffeine + +
+Click to expand + +Caffeine is a simple script that toggles hypridle (disable suspend & screenlock). + +- `caffeine` # Toggle caffeine +- `caffeine-status` # Return active/inactive + +
+ +### Night-Shift + +
+Click to expand + +Blue light filter, using wlsunset + +- `night-shift-on` +- `night-shift-off` + +
+ +### Nerdfont FZF + +
+Click to expand + +Nerdfont fzf is a quick way to search for nerdfont icons locally. +It will copy the selected icon to the clipboard. + +- `nerdfont-fzf` + +
+ +### Compress/Extract + +
+Click to expand + +Some shortcut to compress and extract files. + +- `compress` ... +- `extract` ... + +
\ No newline at end of file diff --git a/hosts/shared/scripts/create_guest_config.sh b/docs/scripts/create_guest_config.sh similarity index 100% rename from hosts/shared/scripts/create_guest_config.sh rename to docs/scripts/create_guest_config.sh diff --git a/docs/scripts/create_readme.sh b/docs/scripts/create_readme.sh new file mode 100644 index 0000000..f1f641a --- /dev/null +++ b/docs/scripts/create_readme.sh @@ -0,0 +1 @@ +#!/usr/bin/env bash diff --git a/docs/scripts/install.sh b/docs/scripts/install.sh new file mode 100644 index 0000000..e69de29 diff --git a/docs/src/README_template.md b/docs/src/README_template.md new file mode 100644 index 0000000..8ab02da --- /dev/null +++ b/docs/src/README_template.md @@ -0,0 +1,71 @@ +

+ +
+ Nixy +
+
+
+ +
+
+ + + + + + + + + + + + + + + +
+
+
+

+ +**Nixy** is a NixOS configuration with home-manager, secrets and custom theming all in one place. +It's a simple way to manage your system configuration and dotfiles. + +## Table of Contents + +{md_table_of_content} + +## Gallery + +![neofetch](https://image.nostr.build/c208c164ae04e4c58e01adb9fab584b163a565155865833851275f89c9270b7a.jpg) +![qutebrowser](https://image.nostr.build/8cc32d981e6be256bdc37a2571c31bb76d7c3335ce7c76fa6eca89a03019bfc9.jpg) +![spotify](https://image.nostr.build/76b18bcbcdf1d911a2dbdff7bfac6652044d45602a3dce9d9c53feb295d13245.jpg) +![wofi](https://image.nostr.build/90d69ffe6251c17e25b0fb44abadaeb0dfe6db8210d935fca14bf8b00be49fa6.jpg) + +## Architecture + +- `home` are the dotfiles and configuration files for the user +- `hosts` are the system configuration files + - `laptop` is mine + - `guest` is a template for you + - `themes` contains all the themes available (you can create your own) + - `shared` are some nix files that you can import (nvidia, prime, fonts, ...) +- `secrets` are the secrets files encrypted with sops + +## Installation/build + +```sh +git clone https://github.com/anotherhadi/nixy ~/.config/nixos +``` + +- Change the username in the flake.nix file +- import the guest configuration instead of the `hosts/laptop` one +- import your hardware-configuration.nix into the `hosts/guest` folder + +```sh +sudo nixos-rebuild switch --flake ~/.config/nixos#nixy +``` + +## Contribute + +Feel free to contribute to this project by opening an issue or a pull request. diff --git a/docs/themes.md b/docs/themes.md new file mode 100644 index 0000000..7e1073e --- /dev/null +++ b/docs/themes.md @@ -0,0 +1,24 @@ +## Settings, Themes and colors + +*Nixy Theme:* + +Font: + Default: SF Apple + Mono: MesloLG Nerd Font + GTK Theme: FlatColor (Based on the colors in variables.nix) + QT Theme: Follow GTK + Icons: + Cursor: + +*Create your own:* + +In your hosts configuration, you should add a `variables.nix` file to manage your settings, including: + +- user information +- timezone and locale +- keyboard layout +- the theme: will be used in programs and for GTK and QT themes +- ... (check the `hosts/guest/variables.nix` file for more information) + +PS: To apply the theme to duckduckgo, follow the instructions in `$HOME/.duckduckgo-colorscheme.js`. + diff --git a/home/laptop.nix b/home/laptop.nix index 54888a6..b4e6e2e 100644 --- a/home/laptop.nix +++ b/home/laptop.nix @@ -42,6 +42,7 @@ nwg-displays wireguard-tools bitwarden-cli + optipng # Just cool peaclock