This commit is contained in:
Hadi 2024-06-17 19:18:05 +02:00
parent 087dd4dfec
commit d8659825a2
14 changed files with 193 additions and 178 deletions

165
README.md
View File

@ -1,88 +1,77 @@
[//]: # (Title: Nixys) [//]: # (Title: Nixy)
[//]: # (Author: Hadi) [//]: # (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.)
[//]: # (Tags: #...) [//]: # (Author: Hadi)
[//]: # (Date: June 17, 2024) [//]: # (Date: 06/17/24)
<h1 align="center"> <div align="center">
<img src="https://image.nostr.build/70ebe2b5183879d8c0ffa682cd0089e030ad01909678b242ed86449517eac3a5.png" width="100px" /> <img src="https://image.nostr.build/70ebe2b5183879d8c0ffa682cd0089e030ad01909678b242ed86449517eac3a5.png" width="100px" />
<br> </div>
Nixy
<br> <br><br>
<img src="https://image.nostr.build/aaf8cf0f3b9784c817f8cf328f19222db2e1886dfb89ae97de83ffa101d437b4.png" width="600px" /> <br>
<div align="center"> <div align="center">
<a href="https://github.com/anotherhadi/nixy">
<div align="center"> <img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=Version&message=2.0.0&colorA=040409&colorB=a158ff&logo=githubactions&logoColor=a158ff&"/>
<p></p> </a>
<div align="center"> <a href="https://github.com/anotherhadi/nixy/stargazers">
<a href="https://github.com/anotherhadi/nixy"> <img src="https://img.shields.io/github/stars/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=starship&logoColor=a158ff">
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=Version&message=2.0.0&colorA=040409&colorB=a158ff&logo=githubactions&logoColor=a158ff&"/> </a>
</a> <a href="https://github.com/anotherhadi/nixy/">
<a href="https://github.com/anotherhadi/nixy/stargazers"> <img src="https://img.shields.io/github/repo-size/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=github&logoColor=a158ff">
<img src="https://img.shields.io/github/stars/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=starship&logoColor=a158ff"> </a>
</a> <a href="https://nixos.org">
<a href="https://github.com/anotherhadi/nixy/"> <img src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor=040409&logo=NixOS&logoColor=a158ff&color=a158ff">
<img src="https://img.shields.io/github/repo-size/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=github&logoColor=a158ff"> </a>
</a> <a href="https://github.com/anotherhadi/nixy/blob/main/LICENSE">
<a href="https://nixos.org"> <img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA=040409&colorB=a158ff&logo=unlicense&logoColor=a158ff&"/>
<img src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor=040409&logo=NixOS&logoColor=a158ff&color=a158ff"> </a>
</a> </div>
<a href="https://github.com/anotherhadi/nixy/blob/main/LICENSE">
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA=040409&colorB=a158ff&logo=unlicense&logoColor=a158ff&"/> <br><br>
</a>
</div> <div align="center">
<br> <img src="https://image.nostr.build/aaf8cf0f3b9784c817f8cf328f19222db2e1886dfb89ae97de83ffa101d437b4.png" width="600px" />
</div> </div>
</h1>
# 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. **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
- [Gallery](#gallery)
- [Architecture](#architechture) - [Nixy](#nixy)
- [Settings, Themes and colors](#settings-themes-and-colors) - [Table of Content](#table-of-content)
- [Scripts](#scripts) - [Gallery](#gallery)
- [Nix/NixOs shortcuts](#nixnixos-shortcuts) - [Architecture](#architecture)
- [Brightness control](#brightness-control) - [Installation](#installation)
- [Sound control](#sound-control)
- [Caffeine](#caffeine) ## Gallery
- [Night-Shift](#night-shift)
- [Nerdfont FZF](#nerdfont-fzf) ![nixy1](docs/src/nixy/1.png)
- [Compress/Extract](#compressextract) ![nixy2](docs/src/nixy/2.png)
- [Installation/build](#installationbuild) ![nixy3](docs/src/nixy/3.png)
## Gallery ## Architecture
![neofetch](https://image.nostr.build/c208c164ae04e4c58e01adb9fab584b163a565155865833851275f89c9270b7a.jpg) - 🏠 `home` are the dotfiles and configuration files for the user
![qutebrowser](https://image.nostr.build/8cc32d981e6be256bdc37a2571c31bb76d7c3335ce7c76fa6eca89a03019bfc9.jpg) - 💻 `hosts` are the system configuration files
![spotify](https://image.nostr.build/76b18bcbcdf1d911a2dbdff7bfac6652044d45602a3dce9d9c53feb295d13245.jpg) - `laptop` is mine
![wofi](https://image.nostr.build/90d69ffe6251c17e25b0fb44abadaeb0dfe6db8210d935fca14bf8b00be49fa6.jpg) - `guest` is a template that you can copy and modify for your own system
- `themes` contains all the themes available (see [[docs/THEMES.md]])
## Architecture - `shared` are some nix files that you can import (nvidia, prime, fonts, ...)
- 🤫 `secrets` are the secrets files encrypted with sops
- `home` are the dotfiles and configuration files for the user
- `hosts` are the system configuration files ## Installation
- `laptop` is mine
- `guest` is a template for you ```sh
- `themes` contains all the themes available (you can create your own) git clone https://github.com/anotherhadi/nixy ~/.config/nixos
- `shared` are some nix files that you can import (nvidia, prime, fonts, ...) ```
- `secrets` are the secrets files encrypted with sops
- Change the username in the flake.nix file
## Installation/build - import the guest configuration instead of the `hosts/laptop` one
- import your hardware-configuration.nix into the `hosts/guest` folder
```sh
git clone https://github.com/anotherhadi/nixy ~/.config/nixos ```sh
``` sudo nixos-rebuild switch --flake ~/.config/nixos#nixy
```
- 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.

View File

@ -30,4 +30,4 @@
| Misc | lazygit | | Misc | lazygit |
| | neofetch | | | neofetch |
| | cava | | | cava |
| | ... | | | ... |

View File

@ -4,7 +4,7 @@ Everybody is invited and welcome to contribute to Nixy. There is a lot to do...
The process is straight-forward. 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) - 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). - Fork Nixy [git repository](https://github.com/anotherhadi/nixy).
- Write your changes (new theme, bug fixes, ...). - Write your changes (new theme, bug fixes, ...).
- Create a Pull Request against the main branch of Nixy. - Create a Pull Request against the main branch of Nixy.

View File

@ -48,4 +48,4 @@ It will copy the selected icon to the clipboard.
Some shortcut to compress and extract files. Some shortcut to compress and extract files.
- `compress` ... - `compress` ...
- `extract` ... - `extract` ...

View File

@ -8,4 +8,4 @@ You can change the selected theme by changing the import statement at the top of
## Create your own theme ## Create your own theme
Create a copy of one of the existing theme and change the variables. Create a copy of one of the existing theme and change the variables.
Wallpapers are loaded from the `home/wallpapers` folder. Wallpapers are loaded from the `home/wallpapers` folder.

View File

@ -1,6 +1,5 @@
# Todolist # Todolist
- [ ] Readme generation
- [ ] Installation script - [ ] Installation script
- [ ] Compress png docs/src - [ ] Compress png docs/src
- [ ] Find a new icon theme (White, flat) - [ ] Find a new icon theme (White, flat)
@ -14,6 +13,6 @@
- [ ] Make hyprcursor work - [ ] Make hyprcursor work
- [ ] Remove folder's laptop conf - [ ] Remove folder's laptop conf
- [ ] Nixvim - [ ] Nixvim
- [ ] Telescope shortcut for file content - [ ] Telescope shortcut for file content
- [ ] Markdown snippets - [ ] Markdown snippets
- [ ] Make whichkey better - [ ] Make whichkey better

View File

@ -1,2 +1,9 @@
# for file in ./docs/src/*.png #!/usr/bin/env bash
# optipng $file
# 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

View File

@ -1,6 +1,14 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# check if file exist: ./docs/src/README_template.md # Create the README.md file from the docs/src/README_template.md file
# copy ./docs/src/README_template.md
# replace {md_table_of_content} by the table of content [[ -d "./docs" ]] || (echo "Folder ./docs not found" && exit 1)
# place it in ./README.md
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"

View File

@ -1 +1,41 @@
# Script to take the rice screenshots #!/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

View File

@ -1,58 +1,30 @@
<h1 align="center">
<img src="https://image.nostr.build/70ebe2b5183879d8c0ffa682cd0089e030ad01909678b242ed86449517eac3a5.png" width="100px" />
<br>
Nixy
<br>
<img src="https://image.nostr.build/aaf8cf0f3b9784c817f8cf328f19222db2e1886dfb89ae97de83ffa101d437b4.png" width="600px" /> <br>
<div align="center">
<div align="center"> # Nixy
<div align="center">
<a href="https://github.com/anotherhadi/nixy">
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=Version&message=2.0.0&colorA=040409&colorB=a158ff&logo=githubactions&logoColor=a158ff&"/>
</a>
<a href="https://github.com/anotherhadi/nixy/stargazers">
<img src="https://img.shields.io/github/stars/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=starship&logoColor=a158ff">
</a>
<a href="https://github.com/anotherhadi/nixy/">
<img src="https://img.shields.io/github/repo-size/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=github&logoColor=a158ff">
</a>
<a href="https://nixos.org">
<img src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor=040409&logo=NixOS&logoColor=a158ff&color=a158ff">
</a>
<a href="https://github.com/anotherhadi/nixy/blob/main/LICENSE">
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA=040409&colorB=a158ff&logo=unlicense&logoColor=a158ff&"/>
</a>
</div>
<br>
</div>
</h1>
**Nixy** is a NixOS configuration with home-manager, secrets and custom theming all in one place. **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. It's a simple way to manage your system configuration and dotfiles.
## Table of Contents ## Table of Content
{md_table_of_content} {md_table_of_content}
## Gallery ## Gallery
![neofetch](https://image.nostr.build/c208c164ae04e4c58e01adb9fab584b163a565155865833851275f89c9270b7a.jpg) ![nixy1](docs/src/nixy/1.png)
![qutebrowser](https://image.nostr.build/8cc32d981e6be256bdc37a2571c31bb76d7c3335ce7c76fa6eca89a03019bfc9.jpg) ![nixy2](docs/src/nixy/2.png)
![spotify](https://image.nostr.build/76b18bcbcdf1d911a2dbdff7bfac6652044d45602a3dce9d9c53feb295d13245.jpg) ![nixy3](docs/src/nixy/3.png)
![wofi](https://image.nostr.build/90d69ffe6251c17e25b0fb44abadaeb0dfe6db8210d935fca14bf8b00be49fa6.jpg)
## Architecture ## Architecture
- `home` are the dotfiles and configuration files for the user - 🏠 `home` are the dotfiles and configuration files for the user
- `hosts` are the system configuration files - 💻 `hosts` are the system configuration files
- `laptop` is mine - `laptop` is mine
- `guest` is a template for you - `guest` is a template that you can copy and modify for your own system
- `themes` contains all the themes available (you can create your own) - `themes` contains all the themes available (see [[docs/THEMES.md]])
- `shared` are some nix files that you can import (nvidia, prime, fonts, ...) - `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 ```sh
git clone https://github.com/anotherhadi/nixy ~/.config/nixos git clone https://github.com/anotherhadi/nixy ~/.config/nixos
@ -65,7 +37,3 @@ git clone https://github.com/anotherhadi/nixy ~/.config/nixos
```sh ```sh
sudo nixos-rebuild switch --flake ~/.config/nixos#nixy sudo nixos-rebuild switch --flake ~/.config/nixos#nixy
``` ```
## Contribute
Feel free to contribute to this project by opening an issue or a pull request.

View File

@ -1,30 +1,34 @@
<h1 align="center"> [//]: # (Title: Nixy)
<img src="https://image.nostr.build/70ebe2b5183879d8c0ffa682cd0089e030ad01909678b242ed86449517eac3a5.png" width="100px" /> [//]: # (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.)
<br> [//]: # (Author: Hadi)
Nixy [//]: # (Date: {date})
<br>
<img src="https://image.nostr.build/aaf8cf0f3b9784c817f8cf328f19222db2e1886dfb89ae97de83ffa101d437b4.png" width="600px" /> <br>
<div align="center">
<div align="center"> <div align="center">
<p></p> <img src="https://image.nostr.build/70ebe2b5183879d8c0ffa682cd0089e030ad01909678b242ed86449517eac3a5.png" width="100px" />
<div align="center"> </div>
<a href="https://github.com/anotherhadi/nixy">
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=Version&message=2.0.0&colorA=040409&colorB=a158ff&logo=githubactions&logoColor=a158ff&"/> <br><br>
</a>
<a href="https://github.com/anotherhadi/nixy/stargazers"> <div align="center">
<img src="https://img.shields.io/github/stars/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=starship&logoColor=a158ff"> <a href="https://github.com/anotherhadi/nixy">
</a> <img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=Version&message=2.0.0&colorA=040409&colorB=a158ff&logo=githubactions&logoColor=a158ff&"/>
<a href="https://github.com/anotherhadi/nixy/"> </a>
<img src="https://img.shields.io/github/repo-size/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=github&logoColor=a158ff"> <a href="https://github.com/anotherhadi/nixy/stargazers">
</a> <img src="https://img.shields.io/github/stars/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=starship&logoColor=a158ff">
<a href="https://nixos.org"> </a>
<img src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor=040409&logo=NixOS&logoColor=a158ff&color=a158ff"> <a href="https://github.com/anotherhadi/nixy/">
</a> <img src="https://img.shields.io/github/repo-size/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=github&logoColor=a158ff">
<a href="https://github.com/anotherhadi/nixy/blob/main/LICENSE"> </a>
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA=040409&colorB=a158ff&logo=unlicense&logoColor=a158ff&"/> <a href="https://nixos.org">
</a> <img src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor=040409&logo=NixOS&logoColor=a158ff&color=a158ff">
</div> </a>
<br> <a href="https://github.com/anotherhadi/nixy/blob/main/LICENSE">
</div> <img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA=040409&colorB=a158ff&logo=unlicense&logoColor=a158ff&"/>
</h1> </a>
</div>
<br><br>
<div align="center">
<img src="https://image.nostr.build/aaf8cf0f3b9784c817f8cf328f19222db2e1886dfb89ae97de83ffa101d437b4.png" width="600px" />
</div>

BIN
docs/src/nixy/1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 MiB

BIN
docs/src/nixy/2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 566 KiB

BIN
docs/src/nixy/3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 811 KiB