diff --git a/README.md b/README.md index 0237a04..dbcd4c7 100644 --- a/README.md +++ b/README.md @@ -1,88 +1,77 @@ -[//]: # (Title: Nixys) -[//]: # (Author: Hadi) -[//]: # (Tags: #...) -[//]: # (Date: June 17, 2024) - -

- -
- 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 - -- [Gallery](#gallery) -- [Architecture](#architechture) -- [Settings, Themes and colors](#settings-themes-and-colors) -- [Scripts](#scripts) - - [Nix/NixOs shortcuts](#nixnixos-shortcuts) - - [Brightness control](#brightness-control) - - [Sound control](#sound-control) - - [Caffeine](#caffeine) - - [Night-Shift](#night-shift) - - [Nerdfont FZF](#nerdfont-fzf) - - [Compress/Extract](#compressextract) -- [Installation/build](#installationbuild) - -## 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. +[//]: # (Title: Nixy) +[//]: # (Description: 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.) +[//]: # (Author: Hadi) +[//]: # (Date: 06/17/24) + +
+ +
+ +

+ +
+ + + + + + + + + + + + + + + +
+ +

+ +
+ +
+ +# 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 Content + +- [Nixy](#nixy) + - [Table of Content](#table-of-content) + - [Gallery](#gallery) + - [Architecture](#architecture) + - [Installation](#installation) + +## Gallery + +![nixy1](docs/src/nixy/1.png) +![nixy2](docs/src/nixy/2.png) +![nixy3](docs/src/nixy/3.png) + +## Architecture + +- 🏠 `home` are the dotfiles and configuration files for the user +- 💻 `hosts` are the system configuration files + - `laptop` is mine + - `guest` is a template that you can copy and modify for your own system + - `themes` contains all the themes available (see [[docs/THEMES.md]]) + - `shared` are some nix files that you can import (nvidia, prime, fonts, ...) +- 🤫 `secrets` are the secrets files encrypted with sops + +## Installation + +```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 +``` diff --git a/docs/APPS.md b/docs/APPS.md index 87acd54..7a3bdea 100644 --- a/docs/APPS.md +++ b/docs/APPS.md @@ -30,4 +30,4 @@ | Misc | lazygit | | | neofetch | | | cava | -| | ... | \ No newline at end of file +| | ... | diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 9a18f91..656e169 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -4,7 +4,7 @@ Everybody is invited and welcome to contribute to Nixy. There is a lot to do... The process is straight-forward. - - Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes (but skip step 0 and 1) - - Fork Nixy [git repository](https://github.com/anotherhadi/nixy). - - Write your changes (new theme, bug fixes, ...). - - Create a Pull Request against the main branch of Nixy. \ No newline at end of file +- Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes (but skip step 0 and 1) +- Fork Nixy [git repository](https://github.com/anotherhadi/nixy). +- Write your changes (new theme, bug fixes, ...). +- Create a Pull Request against the main branch of Nixy. diff --git a/docs/SCRIPTS.md b/docs/SCRIPTS.md index 27089e8..6bb017c 100644 --- a/docs/SCRIPTS.md +++ b/docs/SCRIPTS.md @@ -48,4 +48,4 @@ It will copy the selected icon to the clipboard. Some shortcut to compress and extract files. - `compress` ... -- `extract` ... \ No newline at end of file +- `extract` ... diff --git a/docs/THEMES.md b/docs/THEMES.md index b6df198..580f4e9 100644 --- a/docs/THEMES.md +++ b/docs/THEMES.md @@ -8,4 +8,4 @@ You can change the selected theme by changing the import statement at the top of ## Create your own theme Create a copy of one of the existing theme and change the variables. -Wallpapers are loaded from the `home/wallpapers` folder. \ No newline at end of file +Wallpapers are loaded from the `home/wallpapers` folder. diff --git a/docs/TODO.md b/docs/TODO.md index 9bf604b..ef97871 100644 --- a/docs/TODO.md +++ b/docs/TODO.md @@ -1,6 +1,5 @@ # Todolist -- [ ] Readme generation - [ ] Installation script - [ ] Compress png docs/src - [ ] Find a new icon theme (White, flat) @@ -14,6 +13,6 @@ - [ ] Make hyprcursor work - [ ] Remove folder's laptop conf - [ ] Nixvim - - [ ] Telescope shortcut for file content - - [ ] Markdown snippets - - [ ] Make whichkey better \ No newline at end of file + - [ ] Telescope shortcut for file content + - [ ] Markdown snippets + - [ ] Make whichkey better diff --git a/docs/scripts/compress_src_png.sh b/docs/scripts/compress_src_png.sh index cf50eeb..09f744a 100644 --- a/docs/scripts/compress_src_png.sh +++ b/docs/scripts/compress_src_png.sh @@ -1,2 +1,9 @@ -# for file in ./docs/src/*.png -# optipng $file \ No newline at end of file +#!/usr/bin/env bash + +# Compress png files in ./docs/src + +[[ -d "./docs" ]] || (echo "Folder ./docs not found" && exit 1) + +for file in ./docs/src/*.png; do + optipng "$file" +done diff --git a/docs/scripts/create_readme.sh b/docs/scripts/create_readme.sh index 44c0b3e..795197b 100644 --- a/docs/scripts/create_readme.sh +++ b/docs/scripts/create_readme.sh @@ -1,6 +1,14 @@ #!/usr/bin/env bash -# check if file exist: ./docs/src/README_template.md -# copy ./docs/src/README_template.md -# replace {md_table_of_content} by the table of content -# place it in ./README.md \ No newline at end of file +# Create the README.md file from the docs/src/README_template.md file + +[[ -d "./docs" ]] || (echo "Folder ./docs not found" && exit 1) + +README_FILE="./README.md" + +header=$(cat "./docs/src/header.md") +table_of_content=$(~/go/bin/md-table-of-contents ./docs/src/README_template.md) +readme_content=$(cat "./docs/src/README_template.md") + +echo "${header//\{date\}/$(date '+%D')}" >"$README_FILE" +echo "${readme_content//\{md_table_of_content\}/$table_of_content}" >>"$README_FILE" diff --git a/docs/scripts/take_rice_screenshot.sh b/docs/scripts/take_rice_screenshot.sh index 5afec6e..db77178 100644 --- a/docs/scripts/take_rice_screenshot.sh +++ b/docs/scripts/take_rice_screenshot.sh @@ -1 +1,41 @@ -# Script to take the rice screenshots \ No newline at end of file +#!/usr/bin/env bash + +theme_name="nixy" + +# Switch to workspace 1 +sleep 2 + +# Step 1 +kitty --class peaclock peaclock & +sleep 1 +menu & +sleep 1 +hyprshot -m "output" -m "active" -o "$HOME/.config/nixos/docs/src/$theme_name" -f "1.png" -d +sleep 2 +pkill peaclock +menu +sleep 2 + +# Step 2 +kitty cmatrix & +sleep 1 +kitty & +sleep 1 +qutebrowser & +sleep 3 +hyprshot -m "output" -m "active" -o "$HOME/.config/nixos/docs/src/$theme_name" -f "2.png" -d +sleep 2 +pkill cmatrix +pkill --newest qutebrowser "" +pkill --newest kitty +sleep 2 + +# Step 3 +kitty cava & +sleep 1 +spotify & +sleep 10 +brightness-down +sleep 1 +hyprshot -m "output" -m "active" -o "$HOME/.config/nixos/docs/src/$theme_name" -f "3.png" -d +sleep 2 diff --git a/docs/src/README_template.md b/docs/src/README_template.md index 8ab02da..df2f658 100644 --- a/docs/src/README_template.md +++ b/docs/src/README_template.md @@ -1,58 +1,30 @@ -

- -
- Nixy -
-
-
-
-
- - - - - - - - - - - - - - - -
-
-
-

+# 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 +## Table of Content {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) +![nixy1](docs/src/nixy/1.png) +![nixy2](docs/src/nixy/2.png) +![nixy3](docs/src/nixy/3.png) ## Architecture -- `home` are the dotfiles and configuration files for the user -- `hosts` are the system configuration files +- 🏠 `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) + - `guest` is a template that you can copy and modify for your own system + - `themes` contains all the themes available (see [[docs/THEMES.md]]) - `shared` are some nix files that you can import (nvidia, prime, fonts, ...) -- `secrets` are the secrets files encrypted with sops +- 🤫 `secrets` are the secrets files encrypted with sops -## Installation/build +## Installation ```sh git clone https://github.com/anotherhadi/nixy ~/.config/nixos @@ -65,7 +37,3 @@ git clone https://github.com/anotherhadi/nixy ~/.config/nixos ```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/src/header.md b/docs/src/header.md index 5c15e9d..16257fc 100644 --- a/docs/src/header.md +++ b/docs/src/header.md @@ -1,30 +1,34 @@ -

- -
- Nixy -
-
-
+[//]: # (Title: Nixy) +[//]: # (Description: 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.) +[//]: # (Author: Hadi) +[//]: # (Date: {date}) -
-

-
- - - - - - - - - - - - - - - -
-
-
-

+
+ +
+ +

+ +
+ + + + + + + + + + + + + + + +
+ +

+ +
+ +
diff --git a/docs/src/nixy/1.png b/docs/src/nixy/1.png new file mode 100644 index 0000000..8c00e37 Binary files /dev/null and b/docs/src/nixy/1.png differ diff --git a/docs/src/nixy/2.png b/docs/src/nixy/2.png new file mode 100644 index 0000000..505fb67 Binary files /dev/null and b/docs/src/nixy/2.png differ diff --git a/docs/src/nixy/3.png b/docs/src/nixy/3.png new file mode 100644 index 0000000..35196ac Binary files /dev/null and b/docs/src/nixy/3.png differ